POpoll-the-people
Agent Licenses

List licenses.

Changed on

Returns all access licenses configured for an agent. Licenses control who can interact with the agent and what permissions they have. Use this to manage access distribution.

get/api/v1/projects/{projectId}/licenses

Request

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

Response

List of available agent licenses

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": [
    {
      "name": "My License",
      "key": "123e4567-e89b-12d3-a456-426614174000",
      "project_id": 7,
      "created_at": "2021-01-01 00:00:00",
      "updated_at": "2021-01-01 00:00:00"
    }
  ]
}

Changes

  • 77aab4354382Revision changes
    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

  • b80e6dfcf78dRevision changes
    • info

      endpoint added