Skip to main content

API Secret Management


AnchorOverview

Your API Secret serves as the API Key for most deployment-level requests in Quiltt. This endpoint allows you to validate that your secret is valid and obtain information about your deployment.

AnchorAuthorization

Pass in your API Secret in the Authorization header.

Authorization: Bearer {{API_SECRET}}

AnchorSchemas

Deployment

id string
name string
The name of the deployment
environment objectEnvironment
The environment this deployment is associated with
organization objectOrganization
The organization this deployment belongs to

Environment

id string
mode enum
"TEST" | "SANDBOX" | "DEVELOPMENT" | "PRODUCTION"
name string

Organization

id string
name string

AnchorCheck API Secret

GET
https://auth.quiltt.io/v1/deployments/session

Verify that your API Secret is valid.

Successful requests will return up-to-date information about your Deployment.

AnchorRequest Example

AnchorResponse Examples

200 OK

{
"id": "7d86b825-f937-4cb5-97cc-384603736d7b",
"name": "My Project",
"environment": {
"id": "06559c18-7e0d-4a45-b3a3-b0853af1d9fd",
"mode": "SANDBOX",
"name": "Sandbox"
},
"organization": {
"id": "ab99ef9e-9beb-4265-b8a8-45c4dc55635e",
"name": "Pied Piper"
}
}

401 Unauthorized

{
"message": "Not Authenticated",
"instruction": "Are you setting the `Authorization` header?"
}