POST /api/v2/secret/status
Basic auth

Retrieves the status of multiple secrets in a single request. Accepts a comma-separated list of secret identifiers and returns each secret's current state and metadata. Does not consume or reveal any secret values.

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
      • created string Required
      • updated string Required
      • key string Required
      • shortid string Required
      • state string Required

        Values are new, revealed, burned, or previewed.

      • has_passphrase string | null
      • verification string | null
      • secret_value string
      • is_previewed string | null
      • is_revealed string | null
      • is_viewed string | null
      • is_received string | null
    • 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

      Error type identifier (e.g., "FormError")

    • message string Required

      Human-readable error message

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier
  • 401 application/json

    Unauthorized - Authentication required

    Hide response attributes Show response attributes object
    • error string

      Error type identifier (e.g., "FormError")

    • message string Required

      Human-readable error message

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier
  • 403 application/json

    Forbidden - Insufficient permissions

    Hide response attributes Show response attributes object
    • error string

      Error type identifier (e.g., "FormError")

    • message string Required

      Human-readable error message

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier
  • 404 application/json

    Not Found - Resource does not exist

    Hide response attributes Show response attributes object
    • error string

      Error type identifier (e.g., "FormError")

    • message string Required

      Human-readable error message

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier
  • 422 application/json

    Unprocessable Entity - Validation failed

    Hide response attributes Show response attributes object
    • error string

      Error type identifier (e.g., "FormError")

    • message string Required

      Human-readable error message

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier
  • 500 application/json

    Internal Server Error - Something went wrong

    Hide response attributes Show response attributes object
    • error string

      Error type identifier (e.g., "FormError")

    • message string Required

      Human-readable error message

    • field string

      Field that caused the error, if applicable

    • error_id string

      Unique error tracking identifier
POST /api/v2/secret/status 
curl \
 --request POST 'http://localhost:3000/api/v2/secret/status' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"identifiers":["string"]}'
Request examples 
{
  "identifiers": [
    "string"
  ]
}
Response examples (200) 
{
  "user_id": "string",
  "shrimp": "",
  "records": [
    {
      "identifier": "string",
      "created": "string",
      "updated": "string",
      "key": "string",
      "shortid": "string",
      "state": "new",
      "has_passphrase": "string",
      "verification": "string",
      "secret_value": "string",
      "is_previewed": "string",
      "is_revealed": "string",
      "is_viewed": "string",
      "is_received": "string"
    }
  ],
  "details": {},
  "count": 42
}
Response examples (400) 
{
  "error": "string",
  "message": "string",
  "field": "string",
  "error_id": "string"
}
Response examples (401) 
{
  "error": "string",
  "message": "string",
  "field": "string",
  "error_id": "string"
}
Response examples (403) 
{
  "error": "string",
  "message": "string",
  "field": "string",
  "error_id": "string"
}
Response examples (404) 
{
  "error": "string",
  "message": "string",
  "field": "string",
  "error_id": "string"
}
Response examples (422) 
{
  "error": "string",
  "message": "string",
  "field": "string",
  "error_id": "string"
}
Response examples (500) 
{
  "error": "string",
  "message": "string",
  "field": "string",
  "error_id": "string"
}