Insert a specific Test Distribution pool-specific agent registration key.

Inserts a specific Test Distribution pool-specific agent registration key to connect agents and query the agent pool API. If a key with the same prefix but different key already exists (regardless of which pool it belongs to), it will return 400.

put/api/test-distribution/agent-pools/{poolId}/registration-keys/{keyPrefix}

Request

Base URL
https://develocity.example.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/develocity/apis/develocity-api/docs/api/test-distribution/agent-pools/:poolId/registration-keys/:keyPrefix/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

keystring required

The agent API key.

descriptionstring

Description of the registration key to help identify it later.

Example request

{
  "description": "Used by xyz"
}

Response

The registration key was successfully inserted.

keyPrefixstring required

The registration key prefix.

descriptionstring

Description of the registration key to help identify it later.

createdAtstring date-time required

When the key was created

lastUsedAtstring date-time nullable

When the key was last used

lastUsedBystring nullable

Who used the key last

revokedAtstring date-time nullable

When the key was revoked, a non-null value implies that the key is revoked and can no longer be used to authenticate.

Example response

{
  "description": "Used by xyz"
}

Changes

No recorded changes to this operation across all 1 revision of this API.