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

# Export a stack's configuration as JSON



## OpenAPI

````yaml /openapi/api-docs.yaml get /v1/stacks/{stack_id}/export/configuration
openapi: 3.0.3
info:
  title: StatusStack API
  description: >
    API for managing status monitoring, incidents, stacks, and website
    monitoring.


    You can import this specification directly into Postman, Insomnia or any
    other

    OpenAPI-compatible client.


    Only the operations documented here are part of the supported public API.
    Any other

    endpoint is unstable and may change without a version bump.
  version: 1.4.0
  contact:
    name: StatusStack Support
    url: https://statusstack.com/support
servers:
  - url: https://statusstack.com/api
    description: Production server
security: []
paths:
  /v1/stacks/{stack_id}/export/configuration:
    parameters:
      - name: stack_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Stacks
      summary: Export a stack's configuration as JSON
      responses:
        '200':
          description: Stack configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StackConfigurationExport'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/StackNotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - bearerAuth: []
components:
  schemas:
    StackConfigurationExport:
      type: object
      description: >
        A portable snapshot of a stack's presentation settings and its attached
        sources and

        components. Deliberately excludes ids, so it describes a stack rather
        than identifying one.
      properties:
        version:
          type: string
          example: '1.0'
        exported_at:
          type: string
          format: date-time
        stack:
          type: object
          properties:
            name:
              type: string
            slug:
              type: string
            description:
              type: string
              nullable: true
            visibility:
              $ref: '#/components/schemas/StackVisibility'
            stack_type:
              $ref: '#/components/schemas/StackType'
            theme:
              $ref: '#/components/schemas/StackTheme'
            layout:
              $ref: '#/components/schemas/StackLayout'
            show_timestamps:
              type: boolean
            show_component_names:
              type: boolean
            show_incident_history:
              type: boolean
            incident_history_days:
              type: integer
              nullable: true
        components:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
                nullable: true
              type:
                type: string
                nullable: true
                description: >-
                  Always null. Retained so the exported shape does not change
                  for existing consumers.
              latest_status:
                type: string
                nullable: true
              order:
                type: integer
                nullable: true
        sources:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              url:
                type: string
                format: uri
                nullable: true
                description: The source's status page URL.
              category:
                type: string
                nullable: true
              order:
                type: integer
                nullable: true
    StackVisibility:
      type: string
      enum:
        - public
        - private
        - password
        - unlisted
      description: >
        Who may view the stack's public page. `password` requires a `password`
        on the

        create/update request.
    StackType:
      type: string
      enum:
        - application
        - tech
        - business
        - custom
        - status_page
      description: >
        What the stack groups together, as stored. `status_page` is legacy: it
        is never

        selectable on create, and on update it is accepted only when it is
        already the

        stack's current type.
    StackTheme:
      type: string
      enum:
        - auto
        - light
        - dark
      default: auto
      description: >-
        Colour scheme of the public page. `auto` follows the viewer's system
        preference.
    StackLayout:
      type: string
      enum:
        - grid
        - list
        - compact
      default: grid
      description: How components are arranged on the public page.
    AuthError:
      type: object
      description: >
        The shape for authentication failures and missing API-key permissions.
        These

        responses use `error`, not `message`.
      required:
        - error
      properties:
        error:
          type: string
    ApiError:
      type: object
      description: >
        The standard failure envelope. `errors` appears only when there is
        field-level detail.
      required:
        - message
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties: true
  responses:
    Unauthenticated:
      description: >
        No bearer credentials, or credentials that do not resolve to a valid API
        key. Every

        v1 operation can return it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
    Forbidden:
      description: >
        The API key lacks the required permission, or access to the resource was
        denied.

        The two cases return different bodies, so this is a union rather than
        one shape.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/AuthError'
              - $ref: '#/components/schemas/ApiError'
    StackNotFound:
      description: >
        No such stack, or it lies outside the API key's team scope. On these
        operations the

        two are deliberately indistinguishable — the API returns 404 rather than
        403 — so a

        scoped key cannot probe for stacks it may not see.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    TooManyRequests:
      description: >
        The v1 rate limit (120 requests per minute) was exceeded. Applies to
        every

        operation in the v1 group.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds until the limit resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        StatusStack authenticates requests with API keys, created via the
        dashboard with

        granular permissions (read, write, delete, admin, *).


        API keys support version compatibility:

        - v1 keys: Can only access v1 endpoints

        - v2 keys: Can access both v1 and v2 endpoints


        Available permissions:

        - `read`: View resources (GET requests)

        - `write`: Create and update resources (POST, PUT requests)

        - `delete`: Delete resources (DELETE requests)

        - `admin`: Administrative access to all resources

        - `*`: Wildcard permission (all actions allowed)

````

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