v1

latestSwagger 2.02026-08-061,9128853.7 MB
ApiKeys

Generates a new API key for the specified user. The API key returned in the result must be saved by the caller, as it cannot be retrieved subsequently from the Octopus server.

post/users/{userId}/apikeys

Path parameters

userIdstring required

ID of the user

Request body

ActorType'User' | 'AiAgent'
Expiresstring date-time
Purposestring
UserIdstring required

Response

The created Api Key, containing the unencrypted value of the key which must be saved by the caller, as it cannot be retrieved subsequently from the Octopus server.

ActorType'User' | 'AiAgent'
ApiKeystring
Createdstring date-time
Expiresstring date-time
Idstring
IsLastUsedTimestampKnownboolean
LastModifiedBystring
LastModifiedOnstring date-time
LastUsedTimeStampstring date-time
Linksobject
Purposestring
UserIdstring