API Keys

API keys offer an alternate method of authentication to the Meltano Cloud API using a client ID and secret.

Objects

API Key

Path	JSON Type	Format	Description
`id`	`string`	Version 4 UUID	The API key ID
`created`	`string`	ISO 8601 timestamp	The instant when the API key was created
`lastModified`	`string`	ISO 8601 timestamp	The instant when the API key was last modified
`name`	`string`		The API key name
`clientId`	`string`		The API key client ID
`profileId`	`string`		The API key owner profile ID

{
  "id" : "b796cc9d-be91-4cc2-93ab-b40324bca9dc",
  "created" : "2026-07-13T16:04:38.856412",
  "lastModified" : "2026-07-13T16:04:38.856419",
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)",
  "clientId" : "mJyEoVAYym774LqfYdWb4b03t1rqEHr2",
  "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "update apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "delete apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "profile" : {
      "href" : "https://staging.meltano.com/api/profiles/auth0%7C6a205ea86a76a69d8a3babcb"
    }
  }
}

Requests

View all API keys

GET /api/apikeys

Returns all API keys owned by the authenticated user profile.

Prerequisites

The authenticated user must own a Meltano Cloud account
The API key {apikey-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/apikeys' -i -X GET

import requests

url = "https://staging.meltano.com:443/api/apikeys"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

API key collection with HAL links.

{
  "_embedded" : {
    "apikeys" : [ {
      "id" : "e550a153-d74b-4294-9a60-247cf1021fa3",
      "created" : "2026-07-13T16:04:37.596939",
      "lastModified" : "2026-07-13T16:04:37.596947",
      "name" : "default",
      "clientId" : "9kXtc5mNKWejbMPKCtDFXnIkWRej05zD",
      "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
      "accessToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InMyR2RKS01LUXFwalhkNGFpTU5xVyJ9.eyJpc3MiOiJodHRwczovL2lkZW50aXR5LXN0YWdpbmcubWF0YXRpa2EuY29tLyIsInN1YiI6IjlrWHRjNW1OS1dlamJNUEtDdERGWG5Ja1dSZWowNXpEQGNsaWVudHMiLCJhdWQiOiJodHRwczovL3N0YWdpbmcubWVsdGFuby5jb20vYXBpIiwiaWF0IjoxNzgzOTU4Njc4LCJleHAiOjE3ODQwNDUwNzgsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyIsImF6cCI6IjlrWHRjNW1OS1dlamJNUEtDdERGWG5Ja1dSZWowNXpEIn0.WWXeeP0cJ_K1Lii174sfh8seq2STrJb2cuDw_Tm-if56sDWdxr6_0rgfsN0oS3l08IKaSlOlG-xy2Zc83uyH0OHa96rzUkpfN4DrQdlmZX_LBnr9ekKNsVCf320KKQoR_r5oR8YZZ2OWi0w0Caf5T9bdn6KwpNi-FOPuR1pIwDkouMZp1xv4-ZpSp7KzF6cYsroIakSh0RmzXyWYGCT9I2A3DMVuMbVFUJxNlOeOtOt0U50FPrOqQzbMY_Ayc9z1_xSwjdgt9uw3a7cYwkzhi5YVR8TLeLypogDSslqhG1P26wVGlqwYwdsDZ5BbjImA3qAJzWFhc4sSvLAK5hANdg",
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/apikeys/e550a153-d74b-4294-9a60-247cf1021fa3"
        },
        "update apikey" : {
          "href" : "https://staging.meltano.com/api/apikeys/e550a153-d74b-4294-9a60-247cf1021fa3"
        },
        "delete apikey" : {
          "href" : "https://staging.meltano.com/api/apikeys/e550a153-d74b-4294-9a60-247cf1021fa3"
        },
        "profile" : {
          "href" : "https://staging.meltano.com/api/profiles/auth0%7C6a205ea86a76a69d8a3babcb"
        }
      }
    }, {
      "id" : "b796cc9d-be91-4cc2-93ab-b40324bca9dc",
      "created" : "2026-07-13T16:04:38.856412",
      "lastModified" : "2026-07-13T16:04:38.856419",
      "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)",
      "clientId" : "mJyEoVAYym774LqfYdWb4b03t1rqEHr2",
      "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
        },
        "update apikey" : {
          "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
        },
        "delete apikey" : {
          "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
        },
        "profile" : {
          "href" : "https://staging.meltano.com/api/profiles/auth0%7C6a205ea86a76a69d8a3babcb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/apikeys?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

View an API key

GET /api/apikeys/{apikey-id}

Returns the API key {apikey-id}.

Prerequisites

The authenticated user must own a Meltano Cloud account
The API key {apikey-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc' -i -X GET

import requests

url = "https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

API key with HAL links.

{
  "id" : "b796cc9d-be91-4cc2-93ab-b40324bca9dc",
  "created" : "2026-07-13T16:04:38.856412",
  "lastModified" : "2026-07-13T16:04:38.856419",
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)",
  "clientId" : "mJyEoVAYym774LqfYdWb4b03t1rqEHr2",
  "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "update apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "delete apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "profile" : {
      "href" : "https://staging.meltano.com/api/profiles/auth0%7C6a205ea86a76a69d8a3babcb"
    }
  }
}

Initialise an API key

POST /api/apikeys

Initialises a new API key.

Prerequisites

The authenticated user must own a Meltano Cloud account

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/apikeys' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://staging.meltano.com:443/api/apikeys"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

API key with HAL links.

{
  "id" : "b796cc9d-be91-4cc2-93ab-b40324bca9dc",
  "created" : "2026-07-13T16:04:38.689307696",
  "lastModified" : "2026-07-13T16:04:38.689335263",
  "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
  "_links" : {
    "create apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    }
  }
}

Create an API key

PUT /api/apikeys/{apikey-id}

Creates the API key {apikey-id}.

Prerequisites

The authenticated user must own a Meltano Cloud account

Body

API key resource.

{
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)"
}

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)"
}'

import requests

url = "https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"

data = {
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

201 Created

API key with HAL links.

{
  "id" : "b796cc9d-be91-4cc2-93ab-b40324bca9dc",
  "created" : "2026-07-13T16:04:38.856411955",
  "lastModified" : "2026-07-13T16:04:38.856418707",
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177)",
  "clientId" : "mJyEoVAYym774LqfYdWb4b03t1rqEHr2",
  "clientSecret" : "EGSsFTWWz0cLLO2Ph6uC0TucuMzKShX9aIfkDJwruwX4PJrCJyR30w1BUcwEg2yJ",
  "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "update apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "delete apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "profile" : {
      "href" : "https://staging.meltano.com/api/profiles/auth0%7C6a205ea86a76a69d8a3babcb"
    }
  }
}

Update an API key

PUT /api/apikeys/{apikey-id}

Updates the API key {apikey-id}.

Prerequisites

The authenticated user must own a Meltano Cloud account

Body

API key resource.

{
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177) (updated)"
}

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177) (updated)"
}'

import requests

url = "https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"

data = {
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177) (updated)"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

API key with HAL links.

{
  "id" : "b796cc9d-be91-4cc2-93ab-b40324bca9dc",
  "created" : "2026-07-13T16:04:38.856412",
  "lastModified" : "2026-07-13T16:04:40.481202359",
  "name" : "SIT-generated api key (2026-07-13T16:04:38.747324177) (updated)",
  "clientId" : "mJyEoVAYym774LqfYdWb4b03t1rqEHr2",
  "profileId" : "auth0|6a205ea86a76a69d8a3babcb",
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "update apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "delete apikey" : {
      "href" : "https://staging.meltano.com/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"
    },
    "profile" : {
      "href" : "https://staging.meltano.com/api/profiles/auth0%7C6a205ea86a76a69d8a3babcb"
    }
  }
}

Delete an API key

DELETE /api/apikeys/{apikey-id}

Deletes the API key {apikey-id}.

Prerequisites

The authenticated user must own a Meltano Cloud account
The API key {apikey-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc' -i -X DELETE

import requests

url = "https://staging.meltano.com:443/api/apikeys/b796cc9d-be91-4cc2-93ab-b40324bca9dc"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.

Objects​

API Key​

Requests​

View all API keys​

Prerequisites​

Examples

Response​

View an API key​

Prerequisites​

Examples

Response​

Initialise an API key​

Prerequisites​

Examples

Response​

Create an API key​

Prerequisites​

Body​

Examples

Response​

Update an API key​

Prerequisites​

Body​

Examples

Response​

Delete an API key​

Prerequisites​

Examples

Response​

Objects

API Key

Requests

View all API keys

Prerequisites

Response

View an API key

Prerequisites

Response

Initialise an API key

Prerequisites

Response

Create an API key

Prerequisites

Body

Response

Update an API key

Prerequisites

Body

Response

Delete an API key

Prerequisites

Response