Check API key

Check whether your API key is working properly.

GET /check-api-key

TypeScript

TypeScript

import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.general.checkApiKey();

  console.log(result);
}

run();

200

example1

{ "status": "success", "data": { "environment_id": "2Uev1YUTqLFdvMPD3Jtrg2FX", "customer_id": "2Uev1YUTqLFdvMPD3Jtrg2FX" } }

Authorizations

Authorization · string · header · required

Create an API key on the Secrets page in the Kombo dashboard.

Response

200

application/json

GET /check-api-key Positive response

status · string · required

Allowed value: "success"

data · object · required

Show child attributes

Example:

{
  "environment_id": "2Uev1YUTqLFdvMPD3Jtrg2FX",
  "customer_id": "2Uev1YUTqLFdvMPD3Jtrg2FX"
}