ApiKeys

Get an API Key by ID

get/users/{userId}/apikeys/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/users/{userId}/apikeys/{id}
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

userIdstring required

ID of the User that owns the ApiKey

idstring required

ID of the ApiKeyResource to load

Response

The requested API Key

AccessLevel'FullAccess' | 'ReadOnly' | 'Custom' required

The access level this API key grants.

ActorType'User' | 'AiAgent' required
Createdstring date-time required
Expiresstring date-time
Idstring

Gets or sets a unique identifier for this resource.

IsLastUsedTimestampKnownboolean required

Whether the API key's last-used time is being tracked. False for keys that predate last-used tracking, whose usage history is unknown. When true, a null LastUsedTimeStamp means the key has never been used.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastUsedTimeStampstring date-time

The date and time (UTC) the API key was last used to authenticate; null if it has never been used.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Purposestring
UserIdstring required

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

No recorded changes to this operation across all 13 revisions of this API.