Generate Access Key

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

Generate a new access key for interacting with the Object Storage service. Each access key consists of a unique access_key and a corresponding secret_key scoped to a specific region.

Request Body

---

region string  required

The region where the access key will be valid. Example: "CANADA-1"

---

description string  optional

An optional description for the access key. Max 250 characters.

Attributes

---

access_key string

The generated access key.

---

secret_key string

The corresponding secret key. This is only returned at the time of creation—store it securely.

---

id integer

Unique identifier for the access key.

---

user_id integer

The ID of the user the access key is associated with.

---

region string

The region the access key is scoped to.

---

created_at string (date-time)

Timestamp indicating when the access key was created.

---

description string or null

The description of the key, if provided during creation.

Example request

curl -X POST "https://infrahub-api.nexgencloud.com/v1/object-storage/access-keys" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "api_key: YOUR API KEY" \
  -d '{
    "region": "CANADA-1",
    "description": "For my backup scripts"
  }'

• Include an api_key in the header to authenticate your request. Learn more

Response

{
  "id": 134,
  "user_id": 27,
  "access_key": "AKIA5Q2N7HBC9X7M4LQD",
  "secret_key": "8rVh34exampleSECRETkey",
  "region": "CANADA-1",
  "description": "For my backup scripts",
  "created_at": "2025-05-22T10:14:31Z"
}

Returns

---

Returns a newly created access key and secret key, scoped to the specified region. Be sure to save the secret_key, as it will not be shown again.

Back to top