List Secret Status

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://api.onetimesecret.com/doc/v3-api/mcp

Standard setup for AI tools providing an mcp.json file

{
  "v3 - Secrets API (preview) MCP server": {
    "url": "https://api.onetimesecret.com/doc/v3-api/mcp"
  }
}

POST /api/v3/secret/status

Retrieve the status of multiple secrets in a single request. Accepts a comma-separated list of secret identifiers and returns their current state and metadata.

application/json

Body Required

identifiers array[string] Required

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- user_id string
- shrimp string
  
  Default value is empty.
- records array[object] Required
  
  Hide records attributes Show records attributes object
  
  identifier string Required
  
  key string Required
  
  shortid string Required
  
  state string Required
  
  Values are new, revealed, burned, or previewed.
  
  has_passphrase boolean Required
  
  verification boolean Required
  
  secret_value string
  
  is_previewed boolean Required
  
  is_revealed boolean Required
  
  created number Required
  
  updated number Required
- details object
  
  Additional properties are allowed.
- count integer
  
  Minimum value is -9007199254740991, maximum value is 9007199254740991.
400 application/json

Bad Request - Invalid request parameters or body
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
404 application/json

Not Found - Resource does not exist
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
422 application/json

Unprocessable Entity - Validation failed
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.
500 application/json

Internal Server Error - Something went wrong
Hide response attributes Show response attributes object
- error string
  
  ADR-013: user-facing message (V2+). On frozen V1 this is the error type identifier.
- error_type string
  
  Machine-readable error class the client branches on (ADR-013, e.g., "RecordNotFound")
- message string
  
  Human-readable error message (legacy/V1 shape)
- field string
  
  Field that caused the error, if applicable
- error_id string
  
  Unique error tracking identifier
- request_id string
  
  Request correlation id; mirrors the x-request-id response header and appears in the server request log. Quote this when reporting an error.

POST /api/v3/secret/status

curl \
 --request POST 'https://us.onetimesecret.com/api/v3/secret/status' \
 --header "Content-Type: application/json" \
 --data '{"identifiers":["string"]}'

Request examples

{
  "identifiers": [
    "string"
  ]
}

Response examples (200)

{
  "user_id": "string",
  "shrimp": "",
  "records": [
    {
      "identifier": "string",
      "key": "string",
      "shortid": "string",
      "state": "new",
      "has_passphrase": true,
      "verification": true,
      "secret_value": "string",
      "is_previewed": true,
      "is_revealed": true,
      "created": 42.0,
      "updated": 42.0
    }
  ],
  "details": {},
  "count": 42
}

Response examples (400)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (404)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (422)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}

Response examples (500)

{
  "error": "string",
  "error_type": "string",
  "message": "string",
  "field": "string",
  "error_id": "string",
  "request_id": "string"
}