My Extole LoginGithub
API Reference

Create client key

post
https://api.extole.io/v2/settings/security/keys

Creates a client key from a JSON request body. Supported variants include OAuth integrations, inline PGP or SSH key material, JWT signing keys, webhook secrets, and generic password or HTTP basic credentials. Set algorithm to select the polymorphic request and response schema. Set type to classify what the key is used for.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas.

Allowed:
component_ids
array of strings
component_ids
component_references
array of objects
component_references
required

Optional build-time expression that resolves to a human-readable description.

Static description

string
required

Key material as a string (encoded as ISO-8859-1 bytes). Required format depends on algorithm: symmetric (HS256, HS384, HS512, A128KW, A192KW, A256KW) — shared secret string; RSA/PS *_PUBLIC — PEM BEGIN PUBLIC KEY or DER-encoded X.509 SPKI; RSA/PS *_PRIVATE — PEM BEGIN PRIVATE KEY or PKCS#8 DER; EC *_PRIVATE — PEM EC private key; PASSWORD — plain password; HTTP_BASIC — username:password; OAUTH* — OAuth client secret string.

required

Build-time expression that resolves to the display name for the key.

Static name

string | null
required

External key identifier used to match tokens or credentials to this key (for example the JWT kid header).

tags
array of strings

Free-form tags used to filter active keys on list.

tags
string
enum
required

Usage category that determines how the key is consumed at runtime.

Allowed:
Responses

Updated 21 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago