Platform API ClientClient group5 methodsApiKeysMethods

API Keys

Create, list, rotate, update, and revoke project API keys used for service authentication.

Scoped key creationKey rotationKey revocation

Api Keys

apiKeys.create()

Generated exampleHTTP endpoint wrapperPOST /api/v1/api-keys

POST /api/v1/api-keys

Signature

create(input: CreateApiKeyInput): Promise<CreateApiKeyResponse>

Parameters

Name	Type	Flags
input	CreateApiKeyInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # CreateApiKeyInput

response = platform.apiKeys.create(input)
print(response)

Response

// Response type
Promise<CreateApiKeyResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

apiKeys.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/api-keys

GET /api/v1/api-keys

Signature

list(): Promise<ListApiKeysResponse>

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

response = platform.apiKeys.list()
print(response)

Response

// Response type
Promise<ListApiKeysResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

apiKeys.update()

Generated exampleHTTP endpoint wrapperPUT /api/v1/api-keys/{keyId}

PUT /api/v1/api-keys/{keyId}

Signature

update(keyId: string, input: UpdateApiKeyInput): Promise<ApiKeyRecord>

Parameters

Name	Type	Flags
keyId	string	required
input	UpdateApiKeyInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

keyId = "<keyId>"
input = {}  # UpdateApiKeyInput

response = platform.apiKeys.update(keyId, input)
print(response)

Response

// Response type
Promise<ApiKeyRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

apiKeys.revoke()

Generated exampleHTTP endpoint wrapperDELETE /api/v1/api-keys/{keyId}

DELETE /api/v1/api-keys/{keyId}

Signature

revoke(keyId: string): Promise<void>

Parameters

Name	Type	Flags
keyId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

keyId = "<keyId>"

response = platform.apiKeys.revoke(keyId)
print(response)

Response

// Response type
Promise<void>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

apiKeys.rotate()

Generated exampleHTTP endpoint wrapperPOST /api/v1/api-keys/{keyId}/rotate

POST /api/v1/api-keys/{keyId}/rotate

Signature

rotate(keyId: string): Promise<CreateApiKeyResponse>

Parameters

Name	Type	Flags
keyId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

keyId = "<keyId>"

response = platform.apiKeys.rotate(keyId)
print(response)

Response

// Response type
Promise<CreateApiKeyResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));