GET /api/adapters
  • 30 May 2022
  • 1 Minute to read
  • Dark
    Light
  • PDF

GET /api/adapters

  • Dark
    Light
  • PDF

Returns a list of all the adapters configured in the system.

Header Parameters

The api-key and api-secret are retrieved via the Axonius website. See Get an API Key.

Name In Type Required Description
api-key header string true
api-secret header string true

Query Parameters

Name In Type Required Description
id query string false
get_clients query boolean false Set the endpoint to return "clients" list for each Adapter in the response

Responses

Status Meaning Description Schema
200 OK Success Inline

Example Responses

200 Response

{
  "data": [
    {
      "attributes": {
        "_document_meta": null,
        "adapters_data": [
          {}
        ],
        "id": "string"
      },
      "id": "string",
      "type": "adapters_schema"
    }
  ],
  "meta": {}
}

Response Schema

Status Code 200

Name Type Required Restrictions Description
» data object false none
»» attributes Adapters false none
»»» _document_meta any false none If the parameter get_clients is true then the response includes the schemas for connection and configuration details
»»» adapters_data object false none A list of all the Adapters
»»» id string false none
»» id string false none
»» type string false none
» meta object false none

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.