Posit

Posit Custom Documentation API

The Custom Documentation API from Posit — 1 operation(s) for custom documentation.

GitHub OpenAPI

Operations 3

DELETE /v1/system/documentation Delete custom documentation #
GET /v1/system/documentation Get custom documentation #
POST /v1/system/documentation Set custom documentation #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/posit/refs/heads/main/openapi/posit-custom-documentation-api-openapi.yml

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/posit-custom-documentation-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

posit-custom-documentation-api-openapi.yml Raw ↑ 
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 Custom Documentation API
  version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: Custom Documentation
paths:
  /v1/system/documentation:
    delete:
      description: 'Delete the custom documentation for your Posit Connect server.

        This action is only available to administrators.

        Returns a 204 No Content response if the documentation was successfully deleted.

        Returns a 404 Not Found error if no custom documentation is configured.'
      operationId: deleteCustomDocumentation
      responses:
        '204':
          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.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: The requested object does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: A server error occurred.
      summary: Delete custom documentation
      tags:
      - Custom Documentation
    get:
      description: 'Retrieve the custom documentation for your Posit Connect server, formatted using Markdown.

        Returns a 404 Not Found error if no custom documentation is configured.'
      operationId: getCustomDocumentation
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDocumentationResult'
          description: Successful response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: The requested operation requires authentication.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: The requested object does not exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: A server error occurred.
      summary: Get custom documentation
      tags:
      - Custom Documentation
    post:
      description: 'Set the custom documentation for your Posit Connect server, formatted using Markdown.

        The maximum length for the provided documentation is 500000 characters.

        This action is only available to administrators.

        Returns a 204 No Content response if the documentation was successfully set.'
      operationId: setCustomDocumentation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomDocumentationInput'
        required: true
      responses:
        '204':
          description: Successful response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
          description: The requested operation is invalid.
        '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: Set custom documentation
      tags:
      - Custom Documentation
components:
  schemas:
    CustomDocumentationResult:
      additionalProperties: false
      description: The custom documentation for the Posit Connect server.
      properties:
        content:
          description: The custom documentation content, formatted using Markdown.
          type: string
        created_time:
          description: The time when the custom documentation was created.
          format: date-time
          type: string
      type: object
    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
    CustomDocumentationInput:
      additionalProperties: false
      description: The custom documentation for the Posit Connect server.
      properties:
        content:
          description: The custom documentation content, formatted using Markdown.
          type: string
        created_time:
          description: The time when the custom documentation was created.
          format: date-time
          type: string
      type: object
  securitySchemes:
    apiKey:
      description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.

        '
      in: header
      name: Authorization
      type: apiKey