Posit Server Information API
The Server Information API from Posit — 7 operation(s) for server information.
OpenAPI Specification
openapi: 3.0.3
info:
contact:
email: support@posit.co
name: Posit Connect Support
url: https://support.posit.co/hc/en-us
description: "## Overview\n\nThe Posit Connect Server API can be used to perform certain\nuser actions remotely. You will need to install a tool or library\nthat can make HTTP requests. We recommend using one of our SDKs, which\nare designed to make it easier to interact with the API.\n\n- Python: [posit-sdk](https://github.com/posit-dev/posit-sdk-py/)\n- R: [connectapi](https://posit-dev.github.io/connectapi/)\n\nThe SDKs are designed to work with the following values set in environment\nvariables, though you may provide them directly to the SDK if you prefer:\n\n- `CONNECT_SERVER` - The URL of the Posit Connect server.\n- `CONNECT_API_KEY` - Your API key.\n\nPlease note that all API paths are relative to the base API URL\n(e.g., `https://connect.example.com/__api__`).\nUnless otherwise noted, all endpoints which accept a request body\nwill require the body to be in JSON format.\nSimilarly, all response bodies will be returned in JSON format.\n\n### Specifications {#download}\n\nThe Posit Connect Server API OpenAPI specification is available for\ndownload as either JSON or YAML. Both formats contain the same\ninformation, also presented on this page.\n\n* <a href=\"openapi.json\" title=\"OpenAPI (JSON)\" target=\"_blank\">OpenAPI (JSON)</a>\n* <a href=\"openapi.yaml\" title=\"OpenAPI (YAML)\" target=\"_blank\">OpenAPI (YAML)</a>\n\n### Versioning of the API {#versioning-policy}\n\nThe Posit Connect Server API uses a simple, single number versioning scheme as noted\nas the first part of each endpoint path. This version number will only be incremented\nin the event that non-backward compatible changes are made to an existing endpoint.\nNote that this occurs on a per-endpoint basis; see the section on\n[deprecation](#deprecation) below for more information.\n\nChanges that are considered backward compatible are:\n\n* New fields in responses.\n* New non-required fields in requests.\n* New endpoint behavior which does not violate the current functional intent of the\n endpoint.\n\nChanges that are considered non-backward compatible are:\n\n* Removal or rename of request or response fields.\n* A change of the type or format of one or more request or response fields.\n* Addition of new required request fields.\n* A substantial deviation from the current functional intent of the endpoint.\n\nThe points relating to functional intent are assumed to be extremely rare as more\noften such situations will result in a completely new endpoint, which makes the\nchange a backward compatible addition.\n\n#### Experimentation\n\nPosit Connect labels experimental endpoints in the API by including `/experimental`\nin the endpoint path immediately after the version indicator. If an endpoint is noted\nas experimental, it should not be relied upon for any production work. These are\nendpoints that Posit Connect is making available to our customers to solicit\nfeedback; they are subject to change without notice. Such changes include anything\nfrom altered request/response shapes, to complete abandonment of the endpoint.\n\nThis public review of an experimental endpoint will last as long as necessary to either\nprove its viability or to determine that it's not really needed. The time for this\nwill vary based on the intricacies of each endpoint. When the endpoint is finalized,\nthe next release of Posit Connect will mark the experimental path as deprecated while\nadding the endpoint without the `/experimental` prefix. The path with the experimental\nprefix will be removed six months later. The documentation for the endpoint will also\nnote, during that time, the original, experimental, path.\n\nAll experimental endpoints are clearly marked as such in this documentation.\n\n#### Deprecation and removal of old versions {#deprecation}\n\nIt is possible that Posit Connect may decide to deprecate an endpoint. This will\nhappen if either the endpoint serves no useful purpose because its functionality is\nnow handled by a different endpoint or because there is a newer version of the endpoint\nthat should be used.\n\nIf a deprecated endpoint is called, the response to it will include an extra HTTP\nheader called, `X-Deprecated-Endpoint` and will have as a value the path of the\nendpoint that should be used instead. If the functionality has no direct replacement,\nthe value will be set to `n/a`.\n\nDeprecated versions of an endpoint will be supported for 1 year from the release date\nof Posit Connect in which the endpoint was marked as deprecated. At that time, the\nendpoint is subject to removal at the discretion of Posit Connect. The life cycle\nof an endpoint will follow these steps.\n\n1. The `/v1/endpoint` is public and in use by Posit Connect customers.\n1. Posit Connect makes `/v2/experimental/endpoint` available for testing and feedback.\n Customers should still use `/v1/endpoint` for production work.\n1. Posit Connect moves version 2 of the endpoint out of experimentation so, all within\n the same release:\n 1. `/v1/endpoint` is marked as deprecated.\n 1. `/v2/experimental/endpoint` is marked as deprecated.\n 1. `/v2/endpoint` is made public.\n1. Six months later, `/v2/experimental/endpoint` is removed from the product.\n1. Twelve months later, `/v1/endpoint` is removed from the product.\n\nNote that it is possible that Posit Connect may produce a new version of an existing\nendpoint without making an experimental version of it first. The same life cycle,\nwithout those parts, will still be followed.\n\n### Authentication {#authentication}\n\nAPI endpoints require you to identify yourself as a valid Posit Connect\nuser. You do this by specifying an API key when you make a call to the\nserver. The [API Keys](../user/api-keys/) chapter of the Posit Connect\nUser Guide explains how to create an API key.\n\n#### API Keys {#api-keys}\n\nAPI keys are managed by each user in the Posit Connect\ndashboard. If you ever lose an API key or otherwise feel it has\nbeen compromised, use the dashboard to revoke the key and create\nanother one.\n\n**WARNING**: Keep your API key safe. If your Posit Connect server's URL does not begin\nwith `https`, your API key could be intercepted and used by a malicious actor.\n\nOnce you have an API key, you can authenticate by passing the key with a prefix\nof `\"Key \"` (the space is important) in the Authorization header.\n\nBelow are examples of invoking the \"Get R Information\" endpoint.\n\n##### cURL\n\n```bash\ncurl -H \"Authorization: Key XXXXXXXXXXX\" \\\n https://positconnect.example.com/__api__/v1/server_settings/r\n```\n\n##### R\n\n```r\nlibrary(httr)\napiKey <- \"XXXXXXXXXXX\"\nresult <- GET(\"https://positconnect.example.com/__api__/v1/server_settings/r\",\n add_headers(Authorization = paste(\"Key\", apiKey)))\n```\n\n##### Python\n\n```python\nimport requests\nr = requests.get(\n 'https://positconnect.example.com/__api__/v1/server_settings/r',\n headers = { 'Authorization': 'Key XXXXXXXXXXX' }\n)\n```\n\n### API CORS considerations {#api-cors-considerations}\n\nFor information about using Connect's API from web applications in different domains,\nsee the [Cross-Origin Resource Sharing (CORS)](../admin/security/index.md#cors) section in\nthe security documentation.\n\n### Request correlation {#request-correlation}\n\nPosit Connect assigns a correlation ID to every API request via the\n`X-Correlation-ID` HTTP header. Connect includes this identifier in the response\nheaders and in server-side log entries, making it possible to trace a specific\nrequest through the system.\n\nIf you include an `X-Correlation-ID` header in your request, Connect preserves that\nvalue. If you do not include the header, Connect generates a Universally Unique\nIdentifier (UUID) automatically. Either way, the same value is returned in the\nresponse header.\n\nThis header is useful for:\n\n- **Debugging failed requests**: provide the correlation ID to your administrator so\n they can locate the corresponding server-side log entries.\n- **Correlating client-side and server-side activity**: set a known correlation ID in\n your client and match it against server logs or OpenTelemetry traces.\n\n**Example**\n\n```bash\n# Let Connect generate a correlation ID\ncurl -H \"Authorization: Key XXXXXXXXXXX\" -i \\\n https://positconnect.example.com/__api__/v1/user\n# Response includes: X-Correlation-ID: <generated-uuid>\n\n# Provide your own correlation ID\ncurl -H \"Authorization: Key XXXXXXXXXXX\" \\\n -H \"X-Correlation-ID: my-request-123\" -i \\\n https://positconnect.example.com/__api__/v1/user\n# Response includes: X-Correlation-ID: my-request-123\n```\n\n### API error codes {#api-error-codes}\n\n{{< include src/api_codes.fragment.html >}}\n"
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 API Keys 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:
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
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
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
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
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
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
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
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.
nullable: true
type: object
required:
- code
- error
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
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
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
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
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