Projects -- Api Key

Create API Key

Creates a new API Key for the specified Project. The API Key is used to authenticate requests to the Peaka API on behalf of the Project.

The full key value is only returned once at creation time. Store it securely, as it cannot be retrieved later.

post/projects/{projectId}/apiKeys

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/projects/{projectId}/apiKeys
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project ID

Request body

namestring

Name of the API key

expiresAtstring date-time

The expiration date and time of the API key in ISO-8601 format (e.g., "2025-12-31T23:59:59Z"). If not provided, the API key will not have an expiration date. The time should be in the ISO-8601 standard.

Response

API Key created

namestring

Name of the API key

apiKeystring

API key. It is a secret and should not be shared. Please store it securely. You will not be able to see it again.

apiKeyIdstring uuid

ID of the API key

expiresAtstring date-time

Expiration date of the API key. If null, the API key never expires. The time is in the ISO-8601 standard.

Changes

No recorded changes to this operation across all 1 revision of this API.