Archestra AI Secrets API

The Secrets API from Archestra AI — 3 operation(s) for secrets.

Business capability
Configuration & Secrets Management BC-4210.60

Operations 3

GET /api/secrets/type Get secrets type #
GET /api/secrets/{id} Get secret #
POST /api/secrets/check-connectivity Check secrets connectivity #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/archestra:archestra-secrets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

archestra-secrets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Archestra Secrets API
  version: 1.4.0-rc.47
tags:
- name: Secrets
paths:
  /api/secrets/type:
    get:
      operationId: getSecretsType
      tags:
      - Secrets
      description: 'Get the secrets manager type and configuration details (for Vault)


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:read`: View every organization settings page, including messaging channels'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                    - DB
                    - Vault
                    - BYOS_VAULT
                  meta:
                    type: object
                    additionalProperties:
                      type: string
                required:
                - type
                - meta
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:read
      summary: Get secrets type
      x-summary-source: derived
  /api/secrets/{id}:
    get:
      operationId: getSecret
      tags:
      - Secrets
      description: 'Get a secret by ID


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  name:
                    type: string
                    maxLength: 256
                  secret:
                    type: object
                    additionalProperties: {}
                  isVault:
                    type: boolean
                  isByosVault:
                    type: boolean
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                - id
                - name
                - secret
                - isVault
                - isByosVault
                - createdAt
                - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Get secret
      x-summary-source: derived
  /api/secrets/check-connectivity:
    post:
      operationId: checkSecretsConnectivity
      tags:
      - Secrets
      description: 'Check connectivity to the secrets storage and return secret count.


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  secretCount:
                    type: number
                required:
                - secretCount
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Check secrets connectivity
      x-summary-source: derived