ApiKeys

Get a list of API Keys for a User

Lists all API keys for a user, returning the most recent results first.

get/users/{userId}/apikeys/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/users/{userId}/apikeys/v1
  • 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

Query parameters

partialKeywordstring

Optional case-insensitive filter on the API key purpose or hint.

partialPurposestring

Optional case-insensitive filter on the API key purpose.

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 30

Response

Success

Example response

{
  "ApiKeys": {
    "Items": [
      {
        "Links": {
          "Self": "/api/..."
        }
      }
    ],
    "ItemsPerPage": 30,
    "ItemType": "ApiKey",
    "LastPageNumber": 1,
    "Links": {
      "Self": "/api/..."
    },
    "NumberOfPages": 2,
    "TotalResults": 42
  }
}

Changes

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