Skip to main content

List Access Keys

GET https://infrahub-api.nexgencloud.com/v1/object-storage/access-keys​

Retrieve a list of existing access keys tied to your Object Storage account, including their IDs, descriptions, creation timestamps, and region scopes.


Query string parameters​

search string  optional​

Search for access keys by ID or description.

page integer  optional​

Page number to retrieve. Defaults to 1.

page_size integer  optional​

Number of access keys per page. Maximum is 100. Default is 20.


Attributes​

access_keys array of objects​

List of access key objects returned for your account.

Show child attributes
id integer​

Unique identifier for the access key.

user_id integer​

The ID of the user the access key belongs to.

access_key string​

The access key value.

region string​

The region the key is scoped to.

created_at string (date-time)​

The timestamp the key was created.

description string or null​

An optional description of the key.

meta object​

Pagination metadata.

Show child attributes
count integer​

Total number of access keys.

current_page integer​

The current page number.

total_pages integer​

Total number of available pages.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/object-storage/access-keys?page=1&page_size=20" \
  -H "accept: application/json" \
  -H "api_key: YOUR API KEY"
  • Include an api_key in the header to authenticate your request. Learn more
Response
{
  "access_keys": [
    {
      "id": 134,
      "user_id": 27,
      "access_key": "AKIA5Q2N7HBC9X7M4LQD",
      "region": "CANADA-1",
      "description": "For my backup scripts",
      "created_at": "2025-05-22T10:14:31Z"
    }
  ],
  "meta": {
    "count": 1,
    "current_page": 1,
    "total_pages": 1
  }
}

Returns​

Returns an array of access key objects and pagination metadata.


Back to top​