Secret Keys

Get Secret Keys

get

Gets all secret keys for the project

Responses

200

OK

application/json

alternateSecretKeysstring[]Optional

AlternateSecretKeys are additional secret keys that can be used for an account.

defaultSecretKeystringOptional

DefaultSecretKey is the default secret key for the account.

namesstring[]Optional

Names are the names of the secret keys that can be used for an account. index 0 is the default secret key, index 1+ are alternate secret key names

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/secret-keys

HTTPcURLJavaScriptPython

GET /v1/secret-keys HTTP/1.1
Accept: */*

{
  "alternateSecretKeys": [
    "text"
  ],
  "defaultSecretKey": "text",
  "names": [
    "text"
  ]
}

Add Secret Key

post

Adds a new secret key to the project

Responses

200

OK

application/json

secretKeystringOptional

SecretKey is the secret key that was added.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/secret-keys

HTTPcURLJavaScriptPython

POST /v1/secret-keys HTTP/1.1
Accept: */*

{
  "secretKey": "text"
}

Delete Secret Key

delete

Deletes a secret key from the project

Path parameters

keystringRequired

the key to delete

Responses

200

OK

application/json

alternateSecretKeysstring[]Optional

AlternateSecretKeys are additional secret keys that can be used for an account.

defaultSecretKeystringOptional

DefaultSecretKey is the default secret key for the account.

namesstring[]Optional

Names are the names of the secret keys that can be used for an account. index 0 is the default secret key, index 1+ are alternate secret key names

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/secret-keys/{key}

HTTPcURLJavaScriptPython

DELETE /v1/secret-keys/{key} HTTP/1.1
Accept: */*

{
  "alternateSecretKeys": [
    "text"
  ],
  "defaultSecretKey": "text",
  "names": [
    "text"
  ]
}

Set Default Secret Key

post

Path parameters

keystringRequired

the secret key to set as default

Responses

204

Set default request processed, no content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/secret-keys/{key}/default

HTTPcURLJavaScriptPython

POST /v1/secret-keys/{key}/default HTTP/1.1
Accept: */*

No content

Rename Secret Key

post

Sets or updates the name on an existing secret key

Path parameters

keystringRequired

the secret key to rename

Body

application/json

namestringOptional

Name is the new name to store with the secret key. An empty name clears it.

Responses

204

Rename request processed, no content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/secret-keys/{key}/name

HTTPcURLJavaScriptPython

POST /v1/secret-keys/{key}/name HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content