Check a secret store

Enterprise. Authenticate to the store without reading any secret, and record the answer on the store’s health. A store that refuses or does not answer is an answer, not an error: 200 with health.status: unreachable and a reason.

POST/api/v2/secret-stores/{name}/check

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Path parameters

namestringrequired

The store's name, unique in its environment.

min length 1 · max length 63 · matches ^[a-z0-9][a-z0-9-]{0,62}$

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Secret store settings and health returned; the credential is never exposed.

successbooleanrequired

Allowed:true

dataSecretStorerequired

A secret store's settings and health. Its credential is never exposed by any API.

Show properties

idstringrequired

namestringrequired

typestringrequired

Allowed:aws_secrets_managerhashicorp_vault

descriptionstring | nullrequired

configAwsSecretStoreConfig | VaultSecretStoreConfigrequired

Show properties

One of:

AwsSecretStoreConfig

regionstringrequired

matches ^[a-z]{2}(-[a-z]+)+-\d{1,2}$

authstringrequired

access_key signs with the stored keys. assume_role uses them to assume roleArn first.

Allowed:access_keyassume_role

roleArnstring | null

externalIdstring | null

min length 2 · max length 1224

VaultSecretStoreConfig

addressstring<uri>required

The Vault origin alone

max length 512

namespacestring | null

Vault Enterprise namespace.

mountstring

The KV version 2 mount.

default: "secret"

authstringrequired

Allowed:tokenapprole

authMountstring | null

The AppRole auth mount. Default approle.

credentialKindstringrequired

Which kind of credential is stored. The credential itself is never returned.

Allowed:access_keytokenapprole

allowedPathsstring[] | nullrequired

Path prefixes a secret may point at. Null means any path the credential can read.

cacheTtlSecondsintegerrequired

How long a value read from the store is kept in the API process's memory, never on disk or in a shared cache. 0 reads the store at every dispatch.

min 0 · max 300

healthobject | nullrequired

Show properties

statusstringrequired

Allowed:activeunreachable

checkedAtstring<date-time>required

reasonstring | nullrequired

Allowed:store_unreachablestore_deniedreference_not_foundnull

createdAtstring<date-time>required

updatedAtstring<date-time>required

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

How to get past this error, for a person or an agent. Present on refusals with a known next step, such as a missing scope or role, a plan or billing limit, a halted environment, or a missing secret, connected account, OAuth app or end-user header. Absent when there is no fix to give. Kept in production responses, unlike details.

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An exact anlyon CLI command that fixes it. Absent when no command does.

urlstring<uri>

An absolute console link where a person fixes it.

docsstring<uri>

A docs page that explains it.

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An exact anlyon CLI command that fixes it. Absent when no command does.

urlstring<uri>

An absolute console link where a person fixes it.

docsstring<uri>

A docs page that explains it.

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An exact anlyon CLI command that fixes it. Absent when no command does.

urlstring<uri>

An absolute console link where a person fixes it.

docsstring<uri>

A docs page that explains it.

404

Not Found - Resource does not exist

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An exact anlyon CLI command that fixes it. Absent when no command does.

urlstring<uri>

An absolute console link where a person fixes it.

docsstring<uri>

A docs page that explains it.

429

Too Many Requests - Rate limit exceeded. A workspace's API requests are limited per minute and per UTC clock hour by plan; Retry-After says when to try again, and an hourly refusal names the limit and when the count resets. Successful responses carry the same limits in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (the minute) and X-RateLimit-Limit-Hour, X-RateLimit-Remaining-Hour, X-RateLimit-Reset-Hour (the hour).

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

fixErrorFix

Show properties

summarystringrequired

One sentence that says what to do.

commandstring

An exact anlyon CLI command that fixes it. Absent when no command does.

urlstring<uri>

An absolute console link where a person fixes it.

docsstring<uri>

A docs page that explains it.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.namepath*The store's name, unique in its environment.

Request

curl -X POST 'https://api.anlyon.com/api/v2/secret-stores/string/check' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/secret-stores/string/check", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/secret-stores/string/check",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "id": "sst_01JABCDEF",
    "name": "prod-vault",
    "type": "aws_secrets_manager",
    "description": "string",
    "config": {
      "region": "eu-west-1",
      "auth": "access_key",
      "roleArn": "arn:aws:iam::123456789012:role/anlyon-secrets-reader",
      "externalId": "string"
    },
    "credentialKind": "access_key",
    "allowedPaths": [
      "string"
    ],
    "cacheTtlSeconds": 0,
    "health": {
      "status": "active",
      "checkedAt": "2019-08-24T14:15:22Z",
      "reason": "store_unreachable"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {},
    "fix": {
      "summary": "Log in again and approve the anlyon:secrets consent group, which grants secrets:write.",
      "command": "anlyon auth login --scope anlyon:secrets",
      "url": "https://console.anlyon.com/settings/api-keys",
      "docs": "https://docs.anlyon.com/cli/authentication"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}