> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tofunmiadewuyi.com/custos/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a set

> Returns key names and any backup jobs pinning the set. Values are not included.



## OpenAPI

````yaml /custos/openapi.yaml get /sets/{id}
openapi: 3.1.0
info:
  title: Custos control-plane API
  version: 0.1.0
  description: >
    Seed specification. The auth, identity, key, host-list, and grant endpoints
    below are

    complete; the remaining control-plane endpoints are still being transcribed.
servers:
  - url: https://custos.example.com
    description: Your control plane
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Login, token refresh, and logout.
  - name: Identity
    description: The authenticated user.
  - name: Keys
    description: A user's SSH public keys.
  - name: Credentials
    description: Stored secrets, sealed at rest and audited on every read.
  - name: Permission requests
    description: Time-boxed access requests for gated credentials.
  - name: Sets
    description: >-
      Secret sets — an app's .env, either deployable (private) or team-shared
      (public).
  - name: Hosts
    description: Enrolled machines.
  - name: Health
    description: Liveness and readiness probes.
  - name: Notifications
    description: In-app notifications for the signed-in user.
  - name: Rotation reviews
    description: Credential rotation checklists raised when a user is suspended or removed.
  - name: Audit
    description: Install-wide trails.
  - name: Users
    description: Accounts and their lifecycle.
  - name: Invitations
    description: Onboarding new accounts.
  - name: Groups
    description: Resource groups — a grant on a group cascades to everything in it.
  - name: Grants
    description: Permission grants.
  - name: Enrollment
    description: Admitting a machine to the fleet. Daemon-facing.
  - name: Upgrades
    description: Rolling the daemon fleet forward.
paths:
  /sets/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Sets
      summary: Get a set
      description: >-
        Returns key names and any backup jobs pinning the set. Values are not
        included.
      responses:
        '200':
          description: The set
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Set'
        '403':
          description: Missing `set.read`
        '404':
          description: Not found
components:
  schemas:
    Set:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        public:
          type: boolean
        keys:
          type: array
          items:
            type: string
          description: Environment variable names. Values are never returned here.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        permissions:
          type: array
          items:
            type: string
        backup_jobs:
          type: array
          description: Backup jobs pinning this set, limited to those the reader can see.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              enabled:
                type: boolean
              host_id:
                type: string
                format: uuid
              host_name:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        An opaque access token from /login or /refresh. Tokens are checked
        against the database on every request, so revocation is immediate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.