Posit Server Information API
The Server Information API from Posit — 7 operation(s) for server information.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/posit-server-information-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
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 Server Information API
version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: Server Information
paths:
/v1/server_settings/nodejs:
get:
description: 'This endpoint returns a list of metadata objects for each version
of Node.js that is available for executing content.
This endpoint requires authentication and is only available to
`publisher` and `administrator` roles.'
operationId: getNodeJsInformation
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NodeJsInfo'
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: Get Node.js Information
tags:
- Server Information
/v1/server_settings/public:
get:
description: 'This endpoint returns the minimal server settings needed to render
unauthenticated views in the Connect dashboard.
The returned settings include:
- Authentication provider information (name, notice, timing)
- Self-registration availability
- System display name for branding
- Username validation rules for registration
**Security Note**: This endpoint is public (no authentication required)
and deliberately exposes minimal server settings to unauthenticated
users.'
operationId: getPublicSettings
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSettings'
description: Successful response.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Get public settings
tags:
- Server Information
/v1/server_settings/python:
get:
description: 'This endpoint returns a list of metadata objects for each version
of Python that is available for executing content.
This endpoint requires authentication and is only available to
`publisher` and `administrator` roles.
#### Service tokens
This endpoint can be accessed using a service token with the
`server-settings:read` scope.'
operationId: getPythonInformation
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PythonInfo'
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: Get Python Information
tags:
- Server Information
/v1/server_settings/quarto:
get:
description: 'This endpoint returns a list of metadata objects for each version
of Quarto that is available for executing content.
This endpoint requires authentication and is only available to
`publisher` and `administrator` roles.
#### Service tokens
This endpoint can be accessed using a service token with the
`server-settings:read` scope.'
operationId: getQuartoInformation
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/QuartoInstallations'
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: Get Quarto Information
tags:
- Server Information
/v1/server_settings/r:
get:
description: 'This endpoint returns a list of metadata objects for each version
of R that is available for executing content.
This endpoint requires authentication and is only available to
`publisher` and `administrator` roles.
#### Service tokens
This endpoint can be accessed using a service token with the
`server-settings:read` scope.'
operationId: getRInformation
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RInstallations'
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: Get R Information
tags:
- Server Information
/v1/server_settings/tensorflow:
get:
description: 'This endpoint returns a list of metadata objects for each version
of TensorFlow that is available for executing content.
This endpoint requires authentication and is only available to
`publisher` and `administrator` roles.
#### Service tokens
This endpoint can be accessed using a service token with the
`server-settings:read` scope.'
operationId: getTensorFlowInformation
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TensorFlowInstallations'
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: Get TensorFlow Information
tags:
- Server Information
/v1/timezones:
get:
description: Returns the set of names and offsets for all time zones known by the server.
operationId: getTimeZones
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TimeZoneEntry'
type: array
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: List Time Zones
tags:
- Server Information
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
PublicSettings:
additionalProperties: false
description: 'Minimal server settings required for rendering the login page and
related unauthenticated pages (e.g., password reset, registration).
This is a public endpoint that provides only the information needed
for unauthenticated users to authenticate.'
properties:
authentication:
description: Authentication provider configuration.
type: object
self_registration:
description: 'Whether users can self-register for an account. This is only true
when password authentication is enabled and self-registration is
configured, or when no users exist yet (allowing the first user
to register).'
example: false
type: boolean
system_display_name:
description: The display name for the server, used for branding in the UI.
example: Posit Connect
type: string
public_warning:
description: 'Optional warning message to display on public pages like the
welcome and login pages. Can contain HTML.'
example: ''
type: string
customized_landing:
description: 'Whether a custom landing page is configured to replace the
default welcome page.'
example: false
type: boolean
mail_configured:
description: 'Whether email is configured on the server. This determines whether
features like password reset via email are available.'
example: true
type: boolean
prohibited_usernames:
description: 'List of usernames that are not allowed for new user registration.
These are reserved system names.'
example:
- connect
- apps
- users
- groups
items:
type: string
type: array
username_validator:
description: 'The username validation mode. Either "default" (strict validation
with length and character requirements) or "permissive" (minimal
validation, typically used with external authentication providers).'
example: default
type: string
type: object
PythonInfo:
additionalProperties: false
description: 'This defines the top-level object that describes the data returned by the server.
It contains information about each installation of Python that is known.'
properties:
installations:
description: 'The array of information about Posit Connect''s Python
installations.'
items:
$ref: '#/components/schemas/PyInstallation'
type: array
api_enabled:
description: 'A `true` value is returned only when Python support is enabled in
Connect and API hosting is permitted by the product license. It will
be `false` in all other cases.'
type: boolean
type: object
QuartoInstallation:
additionalProperties: false
description: This defines the information provided by the server about a single installation of Quarto.
properties:
version:
description: The version number of this Quarto installation.
example: 1.0.27
type: string
cluster_name:
description: 'The cluster that contains this Quarto installation.
A value of `Local` indicates that the Quarto installation is local to the
Posit Connect server.'
example: Kubernetes
type: string
image_name:
description: 'The image that contains this Quarto installation.
A value of `Local` indicates that the Quarto installation is local to the
Posit Connect server.'
example: rstudio/content-base:r4.1.3-py3.10.11-jammy
type: string
type: object
TimeZoneEntry:
additionalProperties: false
description: One time zone entry with name and offset.
properties:
timezone:
description: The time zone name.
example: America/New_York
type: string
offset:
description: Time zone offset.
example: -04:00
type: string
type: object
PyInstallation:
additionalProperties: false
description: This defines the information provided by the server about a single installation of Python.
properties:
version:
description: The version number of this Python installation.
example: 3.10.6
type: string
cluster_name:
description: 'The cluster that contains this Python installation.
A value of `Local` indicates that the Python installation is local to the
Posit Connect server.'
example: Kubernetes
type: string
image_name:
description: 'The image that contains this Python installation.
A value of `Local` indicates that the Python installation is local to the
Posit Connect server.'
example: rstudio/content-base:r4.1.3-py3.10.11-jammy
type: string
type: object
TensorFlowInstallation:
additionalProperties: false
description: This defines the information provided by the server about a single installation of TensorFlow.
properties:
version:
description: The version number of this TensorFlow installation.
example: 1.0.27
type: string
cluster_name:
description: 'The cluster that contains this TensorFlow installation.
A value of `Local` indicates that the TensorFlow installation is local to
the Posit Connect server.'
example: Kubernetes
type: string
image_name:
description: 'The image that contains this TensorFlow installation.
A value of `Local` indicates that the TensorFlow installation is local to
the Posit Connect server.'
example: rstudio/content-base:r4.1.3-py3.10.11-jammy
type: string
type: object
RInstallation:
additionalProperties: false
description: This defines the information provided by the server about a single installation of R.
properties:
version:
description: The version number of this R installation.
example: 3.4.4
type: string
cluster_name:
description: 'The cluster that contains this R installation.
A value of `Local` indicates that the R installation is local to the Posit
Connect server.'
example: Kubernetes
type: string
image_name:
description: 'The image that contains this R installation.
A value of `Local` indicates that the R installation is local to the Posit
Connect server.'
example: rstudio/content-base:r4.1.3-py3.10.11-jammy
type: string
type: object
QuartoInstallations:
additionalProperties: false
description: 'This defines the top-level object that describes the data returned by the server.
It contains information about each installation of Quarto that is known.'
properties:
installations:
description: 'The array of information about Posit Connect''s Quarto
installations.'
items:
$ref: '#/components/schemas/QuartoInstallation'
type: array
type: object
NodeJsInfo:
additionalProperties: false
description: 'This defines the top-level object that describes the data returned by the server.
It contains information about each installation of Node.js that is known.'
properties:
installations:
description: The array of information about Posit Connect's Node.js installations.
items:
$ref: '#/components/schemas/NodeJsInstallation'
type: array
enabled:
description: 'A `true` value is returned only when Node.js support is enabled in
Connect and Node.js content is permitted by the product license
(Advanced tier or Evaluation). It will be `false` in all other cases.'
type: boolean
type: object
TensorFlowInstallations:
additionalProperties: false
description: 'This defines the top-level object that describes the data returned by the server.
It contains information about each installation of TensorFlow that is known.'
properties:
installations:
description: 'The array of information about Posit Connect''s TensorFlow
installations.'
items:
$ref: '#/components/schemas/TensorFlowInstallation'
type: array
type: object
RInstallations:
additionalProperties: false
description: 'This defines the top-level object that describes the data returned by the server.
It contains information about each installation of R that is known.'
properties:
installations:
description: 'The array of information about Posit Connect''s R
installations.'
items:
$ref: '#/components/schemas/RInstallation'
type: array
type: object
NodeJsInstallation:
additionalProperties: false
description: This defines the information provided by the server about a single installation of Node.js.
properties:
version:
description: The version number of this Node.js installation.
example: 22.11.0
type: string
cluster_name:
description: 'The cluster that contains this Node.js installation.
A value of `Local` indicates that the Node.js installation is local to the
Posit Connect server.'
example: Kubernetes
type: string
image_name:
description: 'The image that contains this Node.js installation.
A value of `Local` indicates that the Node.js installation is local to the
Posit Connect server.'
example: Local
type: string
type: object
securitySchemes:
apiKey:
description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.
'
in: header
name: Authorization
type: apiKey