Skip to main content

Get a secret's metadata

POST 
/api/v1/secrets/get-metadata

Returns the secret’s metadata without exposing the credential. Unknown names return 404. The metadata revision records that row; after a partially failed write it is not independent proof of the actual stored credential version.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized tenant project secret administration.

Use this in a guide: Answer questions about a website using your own Firecrawl account · Secret values and credential references

Request​

Responses​

Metadata returned

Use the name of an existing secret in the authenticated project.​

Section ID: DOC-CP-secrets-api-getSecretMetadata#example-secrets-getSecretMetadata-request

Request example

{
  "name": "travel-provider-api-key"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-secrets-api-getSecretMetadata#example-secrets-getSecretMetadata-response

Response example

{
  "metadata": {
    "name": "example",
    "projectId": "example_123",
    "description": "example",
    "labels": {},
    "version": "1",
    "createdBy": "example",
    "createdAt": "2026-09-16T12:00:00Z",
    "updatedAt": "2026-09-16T12:00:00Z"
  }
}

Document ID: DOC-CP-secrets-api-getSecretMetadata. Section identities and revisions.

SectionStable reference
Get a secret's metadataDOC-CP-secrets-api-getSecretMetadata#overview
RequestDOC-CP-secrets-api-getSecretMetadata#request
ResponsesDOC-CP-secrets-api-getSecretMetadata#responses