Get Your Keys

To authenticate and interact with Splight's API, you need an access key. Follow the steps below to generate one from the Splight web interface or directly through the API.

Web Interface

Log in to Splight

Go to Splight's website and log in with the name of your organization, your email, and password.

Access Settings

Click your username in the bottom-left corner of the screen to open the settings menu.

Navigate to Account

In the settings menu, select the "Account" tab.

Generate Access Key

In the Access Keys section, click "New Key". This will create a new access key for you.

Copy Access Key

After generating the key, copy it and store it securely. You will need this key to authenticate your API requests.

Using the API

You can also request a new access key by making a POST request:

POST https://api.splight.com/v3/account/credentials/access/

Example Request

curl --request POST \
  --url https://api.splight.com/v3/account/credentials/access/ \
  --header 'authorization: Splight <access_id> <secret_key>' \

import http.client

conn = http.client.HTTPSConnection("api.splight.com")

headers = { 'authorization': "Splight <access_id> <secret_key>" }

conn.request("POST", "/v3/account/credentials/access/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
    "access_id": "2c9ab486-7d73-4e9e-99e4-eb7cda16d5a9",
    "id": 1,
    "description": null,
    "created_date": "2023-10-01T12:00:00Z",
    "last_used": null,
    "organization": "org_86DQsme8bptKaU",
    "secret_key": "b827ca2df332445f4bbd2055da0e6b83da8e5eae0c916a5c193973b2fac7465a"
}

Key Management: You can manage your access keys from the Splight web interface. You can view, edit, or delete existing keys as needed.
Security: Always keep your access and secret keys secure. Do not share them publicly or expose them in your code repositories.
Key Expiration: Access keys do not expire unless manually revoked.
Key Limit: You can have a maximum of two active keys at any given time. If you need to create a new key and have already reached the limit, simply delete an existing key and repeat the steps above.

PreviousREADME NextAPI Introduction

Last updated 2 months ago

Was this helpful?