Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
API keys

Create API Key

Create a new API key. This is the only time api-key-secret is shown.

post/v0/organizations/{organization-id}/api-keys

Path parameters

organization-idstring required

Request body

{"stackTrail":"paths:/v0/organizations/{organization-id}/api-keys:post:requestBody:content:application/json:schema:properties:api-key-name","oasType":"schema","type":"unknown","title":"api-key-name","description":"The name of the API Key. Cannot contain whitespace."}

Response

Created

api-key-namestring required

The immutable display name for the API key

api-key-live?boolean required
organization-urlstring required

Link to the organization.

user-urlstring required

Link to the user.

created-atstring date-time required

ISO 8601 formatted date-time.

api-key-secretstring required

The API secret

Example response

{
  "api-key-name": "buildserver",
  "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  "api-key-secret": "g-test-buildserver-RrUZ5fUG4pSKwYVVG1C3Ft1xrMRxy1T7KUIyTva5bTk"
}