Product Selector

Fusion 5.12
    Fusion 5.12

    API Keys

    API Keys are an access control feature that allows users to create, store, and manage their API credentials in a secure manner. Only Fusion users with admin permissions can manage API Keys.

    You can use an API key instead of a username and password combination to power your search application or operations.

    In the examples on this page, you can use either the apiKey or x-api-key query parameter.

    The following example authenticates a request to check the status of the query service with an API key:

    curl -H "x-api-key: API_KEY" "https://FUSION_HOST:FUSION_PORT/api/query/status"

    There isn’t a hard limit on the amount of API Keys you can create.

    Manage API keys in the Fusion UI

    You can create, delete, and view the names of API keys in the UI:

    1. Navigate to System > Access Control > API Keys.

    2. Select Add API Key.

    3. Give the API key a name.

    4. Assign the appropriate roles to give the API key the correct permissions for your search application.

    5. Select Generate Key.

    6. Copy the API key that appears. Save this key in a secure location.

    API keys are treated like an automatically generated password. They are only visible during the key creation and do not display again. You must copy and securely store the API key to see it again after creation.

    Manage API keys with the API

    You can use GET, POST, and DELETE HTTP requests to manage your API keys. The following examples use an API key to authenticate. To use an API key in an API request, use the x-api-key HTTP request header.

    Create a new API key

    Use a POST HTTP request to create a new API key. Assign the appropriate roles to give the API key the correct permissions for your search application.

    API keys are treated like an automatically generated password. They are only visible during the key creation and do not display again. You must copy and securely store the API key to see it again after creation.
    Request
    curl -H "x-api-key: API_KEY" -X POST "https://FUSION_HOST:FUSION_PORT/api/api-key" -d '
    {
      "name": "searchaccess",
      "id": "api-key-searchaccess-16744867518441",
      "roles": ["rules", "search-template", "search"]
    }
    '
    Response
    {
      "name": "searchaccess",
      "id": "api-key-searchaccess-16744867518441",
      "key": "API_KEY",
      "roles": [
        "rules", "search-template", "search"
      ],
      "createdAt": "2023-01-23T15:12:32Z"
    }
    The value of the key field is the API key.

    List all available API keys

    Use a GET HTTP request to view all API keys.

    The API key values are not included in the response. You can only access API keys at the time of creation.

    Request
    curl -H "x-api-key: API_KEY" -X GET "https://FUSION_HOST:FUSION_PORT/api/api-key"
    Response
    [{
      "name": "searchaccess",
      "id": "api-key-searchaccess-16744867518441",
      "createdAt": "2023-01-23T15:12:32Z",
      "roles": ["rules", "search-template", "search"]
    }, {
      "name": "adminaccess",
      "id": "api-key-test-5-16630249022972",
      "createdAt": "2022-09-12T23:21:42Z",
      "roles": ["admin"]
    }]

    Get details about an API key

    Use a GET HTTP request to get the details of a specific API key. You must supply the ID of the API key as part of your request URL.

    Request
    curl -H "x-api-key: API_KEY" -X GET "https://FUSION_HOST:FUSION_PORT/api/api-key/API_KEY_ID"
    Response
    {
      "name": "searchaccess",
      "id": "api-key-searchaccess-16744867518441",
      "createdAt": "2023-01-23T15:12:32Z",
      "roles": ["rules", "search-template", "search"]
    }

    Delete an API key

    Use a DELETE HTTP request to delete a specific API key. You must supply the ID of the API key as part of your request.

    The request returns an HTTP 200 OK status code when the API key is successfully deleted.

    Request
    curl -H "x-api-key: API_KEY" -X DELETE "https://FUSION_HOST:FUSION_PORT/api/api-key/API_KEY_ID"