API Keys

Get Api Keys

Get all API keys registered to the user

get

/v2/api-keys

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.mlfoundry.com/v2/api-keys' \
  --header 'Authorization: Bearer fkey_<key>'

200

401

200

[
  {
    "fid": "apikey_abc123456",
    "name": "text",
    "created_at": "2024-01-01T00:00:00Z",
    "expires_at": "2024-01-01T00:00:00Z",
    "deactivated_at": "2024-01-01T00:00:00Z",
    "snippet": "fkey_abc1..."
  }
]

Successful Response

Create Api Key

Create a new API key

post

/v2/api-keys

Authorizations

Body

namestringrequired

expires_atanyrequired

Example: 2024-01-01T00:00:00Z

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.mlfoundry.com/v2/api-keys' \
  --header 'Authorization: Bearer fkey_<key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "expires_at": "2024-01-01T00:00:00Z"
  }'

201

400

401

422

201

{
  "fid": "apikey_abc123456",
  "name": "text",
  "created_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-01-01T00:00:00Z",
  "deactivated_at": "2024-01-01T00:00:00Z",
  "snippet": "fkey_abc1...",
  "secret": "fkey_abc123456"
}

Successful Response

Revoke Api Key

Revoke an API key

delete

/v2/api-keys/{key_fid}

Authorizations

Path parameters

key_fidstringrequired

Example: apikey_abc123456

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.mlfoundry.com/v2/api-keys/{key_fid}' \
  --header 'Authorization: Bearer fkey_<key>'

204

400

401

404

422

204

No body

Successful Response