How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Posit Custom Documentation API

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

Posit Custom Documentation API is one of 33 APIs that Posit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Documentation. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against a single base URL, /__api__.

3 operations 1 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://connect.example.com/__api__
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Posit Custom Documentation API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — Prefix your API key with Key , e.g. Key ABC123.

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Documentation 3
DELETE
/v1/system/documentation
Delete custom documentation
deleteCustomDocumentation → 204401403404500
GET
/v1/system/documentation
Get custom documentation
getCustomDocumentation → 200401404500
POST
/v1/system/documentation
Set custom documentation
setCustomDocumentation body → 204400401403500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are APIError (3 properties), CustomDocumentationResult (2 properties), CustomDocumentationInput (2 properties). Each schema is shown below with its type and property counts.

APIError
object
The error object returned by the API on failure.
3 properties 2 required
CustomDocumentationInput
object
The custom documentation for the Posit Connect server.
2 properties
CustomDocumentationResult
object
The custom documentation for the Posit Connect server.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posit-custom-documentation-api-openapi.yml Raw ↑

Other APIs Posit publishes across the network.

Posit API Keys API
Posit Audit Logs API
Posit Bookmarks API
Posit Bootstrap API
Posit Bundles API
Posit Content API
Posit Content Permissions API
Posit Environment Permissions API
Posit Environments API
Posit Examples API
Posit Feature Usage API
Posit Groups API
Where this information came from

This is an independent, third-party profile of Posit Custom Documentation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.