Posit Bootstrap API

openapi: 3.2.0
info:
  contact:
    email: support@posit.co
    name: Posit Connect Support
    url: https://support.posit.co/hc/en-us
  description: '## Overview


    The Posit Connect Server API can be used to perform certain

    user actions remotely.'
  license:
    name: Commercial. Copyright 2015-2026 Posit Software, PBC. All Rights Reserved.
    url: https://posit.co/about/eula/
  termsOfService: https://posit.co/about/eula/
  title: Posit Connect API Reference Bootstrap API
  version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: Bootstrap
paths:
  /v1/bootstrap:
    post:
      description: 'This endpoint creates an initial administrator user, provisions an API key for the initial administrator,

        and returns the API key. This endpoint only functions for installations with no pre-existing users.


        #### Code samples


        ::: {.panel-tabset}


        ##### curl


        ```bash

        #!/bin/bash


        BOOTSTRAP_JWT="your.jwt.here"


        curl --silent --show-error -L --max-redirs 0 --fail \

        -X POST \

        -H "Authorization: Connect-Bootstrap ${BOOTSTRAP_JWT}" \

        "https://connect.example.com/__api__/v1/bootstrap"

        ```


        ##### Python


        ```python

        import requests


        bootstrap_jwt = "your.jwt.here"

        headers = { ''Authorization'': ''Connect-Bootstrap '' + bootstrap_jwt }


        response = requests.post("https://connect.example.com/__api__/v1/bootstrap",

        headers=headers)

        ```


        ##### R


        ```r

        library(httr)


        bootstrapJwt <- "your.jwt.here"


        result <- POST("https://connect.example.com/__api__/v1/bootstrap",

        add_headers(Authorization = paste("Connect-Bootstrap", bootstrapJwt)))

        ```


        :::'
      operationId: bootstrap
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BootstrapSuccess'
          description: Successful response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: The requested operation requires authentication.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: You do not have permission to perform this operation.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: A server error occurred.
      summary: Create first administrator and API key
      tags:
      - Bootstrap
  /v1/experimental/bootstrap:
    post:
      deprecated: true
      description: 'This endpoint creates an initial administrator user, provisions an

        API key for the initial administrator, and returns the API key. This

        endpoint only functions for installations with no pre-existing users.


        This endpoint is deprecated. Use POST /v1/bootstrap instead.'
      operationId: bootstrapExperimental
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BootstrapSuccess'
          description: Successful response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: The requested operation requires authentication.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: You do not have permission to perform this operation.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: A server error occurred.
      summary: Create first administrator and API key
      tags:
      - Bootstrap
components:
  schemas:
    APIError:
      additionalProperties: false
      description: The error object returned by the API on failure.
      properties:
        code:
          description: The specific code for the type of error returned. See the [API error codes reference](#api-error-codes) for the full set of values.
          type: integer
        error:
          description: A description of the problem that was encountered.
          type: string
        payload:
          description: Additional error details, if any. The structure varies by error type.
          type:
          - object
          - 'null'
      required:
      - code
      - error
      type: object
    BootstrapSuccess:
      additionalProperties: false
      properties:
        api_key:
          description: The API key for the newly created administrator user.
          type: string
      type: object
  securitySchemes:
    apiKey:
      description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.

        '
      in: header
      name: Authorization
      type: apiKey