Posit Environments API
The Environments API from Posit — 2 operation(s) for environments.
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 Environments API
version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: Environments
paths:
/v1/environments:
get:
description: 'List all execution environments available to Posit Connect.
You must have administrator or publisher privileges to perform this action.'
operationId: listEnvironments
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Environment'
type: array
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.
'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: List execution environments
tags:
- Environments
post:
description: 'Create a new execution environment.
You must have administrator privileges to perform this action.'
operationId: createEnvironment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironmentInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
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.
'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: Create execution environment
tags:
- Environments
/v1/environments/{guid}:
delete:
description: 'Delete a specific execution environment.
You must have administrator privileges to perform this action.
Environments managed by a configuration file cannot be deleted via the API.'
operationId: deleteEnvironment
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
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.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The request could not be completed due to a conflict.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Delete an execution environment
tags:
- Environments
get:
description: 'Get detailed information about a specific execution environment.
You must have administrator or publisher privileges to perform this action.'
operationId: getEnvironment
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
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.
'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 execution environment details
tags:
- Environments
put:
description: 'Update a specific execution environment.
You must have administrator privileges to perform this action.
Environments managed by a configuration file cannot be updated via the API.'
operationId: updateEnvironment
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironmentInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
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.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The request could not be completed due to a conflict.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Update an execution environment
tags:
- Environments
components:
schemas:
Installations:
additionalProperties: false
description: A list of language installations available to an environment.
properties:
installations:
description: The list of language installations.
items:
$ref: '#/components/schemas/Installation'
type: array
type: object
VolumeMount:
additionalProperties: false
description: A volume mount configuration for an environment.
properties:
source:
allOf:
- $ref: '#/components/schemas/VolumeSource'
description: The source specification for this mount.
target:
allOf:
- $ref: '#/components/schemas/VolumeTarget'
description: The target specification for this mount.
type: object
Environment:
additionalProperties: false
description: An execution environment available to Posit Connect when Off Host Execution is enabled.
properties:
id:
description: The internal numeric identifier of this environment.
example: '314'
type: string
guid:
description: The unique identifier of this environment to be used with REST API requests.
example: 25438b83-ea6d-4839-ae8e-53c52ac5f9ce
format: uuid
type: string
created_time:
description: The timestamp (RFC3339) indicating when this environment was created.
example: '2006-01-02T15:04:05-07:00'
format: date-time
type: string
updated_time:
description: The timestamp (RFC3339) indicating when this environment was last updated.
example: '2006-01-02T15:04:05-07:00'
format: date-time
type: string
title:
description: A human readable title for this environment.
example: Project Alpha (R 4.1.1, Python 3.10)
nullable: true
type: string
description:
description: A human readable description of this environment.
example: This is my description of the environment
nullable: true
type: string
cluster_name:
description: 'The cluster identifier for this environment.
The value is always "Kubernetes" when Off Host Execution is enabled.'
example: Kubernetes
type: string
name:
description: 'The container image that will be used when executing content with this
environment.'
example: ghcr.io/rstudio/content-base:r4.1.3-py3.10.4-ubuntu1804
type: string
environment_type:
description: 'The type of environment.
The value is always "Kubernetes" when Off Host Execution is enabled.'
example: Kubernetes
type: string
matching:
description: 'This field indicates how environments can be considered for selection
when Posit Connect is choosing a compatible environment to use when
executing content.
`any` (the default) indicates that the image can be selected by Connect
automatically,
_or_ targeted in the bundle''s manifest.
`exact` indicates the image must be explicitly asked for in the bundle''s
manifest.
`none` indicates that the image should never be selected by Posit Connect.'
example: any
type: string
supervisor:
description: 'The path to the script or command that should be used as the
[program
supervisor](https://docs.posit.co/helm/rstudio-connect/kubernetes-howto/appendices/content_images.html#per-image-supervisors)
when executing content with this environment.'
example: /usr/local/bin/supervisor.sh
nullable: true
type: string
managed_by:
description: 'Indicates which system manages this environment. A `null` value indicates
the environment is not externally managed.'
nullable: true
type: string
python:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Python installations in this environment.
nodejs:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Node.js installations in this environment.
quarto:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Quarto installations in this environment.
r:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available R installations in this environment.
tensorflow:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available TensorFlow installations in this environment.
volume_mounts:
description: The volume mounts for this environment.
items:
$ref: '#/components/schemas/VolumeMount'
type: array
type: object
VolumeTarget:
additionalProperties: false
description: The target specification for a volume mount.
properties:
path:
description: The mount path inside the container.
example: /mnt/data
type: string
read_only:
description: Whether the volume is mounted read-only.
example: false
nullable: true
type: boolean
type: object
UpdateEnvironmentInput:
additionalProperties: false
description: The fields that can be specified when updating an environment.
properties:
title:
description: A human readable title for this environment.
example: Project Alpha (R 4.1.1, Python 3.10)
nullable: true
type: string
description:
description: A human readable description of this environment.
example: This is my description of the environment
nullable: true
type: string
matching:
description: 'This field indicates how environments can be considered for selection
when Posit Connect is choosing a compatible environment to use when
executing content.
`any` (the default) indicates that the image can be selected by Connect
automatically,
_or_ targeted in the bundle''s manifest.
`exact` indicates the image must be explicitly asked for in the bundle''s
manifest.
`none` indicates that the image should never be selected by Posit Connect.'
example: any
nullable: true
type: string
supervisor:
description: 'The path to the script or command that should be used as the
[program
supervisor](https://docs.posit.co/helm/rstudio-connect/kubernetes-howto/appendices/content_images.html#per-image-supervisors)
when executing content with this environment.'
example: /usr/local/bin/supervisor.sh
nullable: true
type: string
python:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Python installations in this environment.
nodejs:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Node.js installations in this environment.
quarto:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Quarto installations in this environment.
r:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available R installations in this environment.
tensorflow:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available TensorFlow installations in this environment.
volume_mounts:
description: The volume mounts for this environment.
items:
$ref: '#/components/schemas/VolumeMount'
type: array
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
CreateEnvironmentInput:
additionalProperties: false
description: The fields that can be specified when creating an environment.
properties:
title:
description: A human readable title for this environment.
example: Project Alpha (R 4.1.1, Python 3.10)
nullable: true
type: string
description:
description: A human readable description of this environment.
example: This is my description of the environment
nullable: true
type: string
cluster_name:
description: 'The cluster identifier for this environment.
The value must be "Kubernetes" when Off Host Execution is enabled.'
example: Kubernetes
type: string
name:
description: 'The container image that will be used when executing content with this
environment.'
example: ghcr.io/rstudio/content-base:r4.1.3-py3.10.4-ubuntu1804
type: string
matching:
description: 'This field indicates how environments can be considered for selection
when Posit Connect is choosing a compatible environment to use when
executing content.
`any` (the default) indicates that the image can be selected by Connect
automatically,
_or_ targeted in the bundle''s manifest.
`exact` indicates the image must be explicitly asked for in the bundle''s
manifest.
`none` indicates that the image should never be selected by Posit Connect.'
example: any
nullable: true
type: string
supervisor:
description: 'The path to the script or command that should be used as the
[program
supervisor](https://docs.posit.co/helm/rstudio-connect/kubernetes-howto/appendices/content_images.html#per-image-supervisors)
when executing content with this environment.'
example: /usr/local/bin/supervisor.sh
nullable: true
type: string
python:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Python installations in this environment.
nodejs:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Node.js installations in this environment.
quarto:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available Quarto installations in this environment.
r:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available R installations in this environment.
tensorflow:
allOf:
- $ref: '#/components/schemas/Installations'
description: The available TensorFlow installations in this environment.
volume_mounts:
description: The volume mounts for this environment.
items:
$ref: '#/components/schemas/VolumeMount'
type: array
type: object
Installation:
additionalProperties: false
description: An instance of an interpreter within an execution environment.
properties:
version:
description: The semantic version of the interpreter.
example: 3.6.3
type: string
path:
description: The absolute path to the interpreter's executable.
example: /opt/R/3.6.3/bin/R
type: string
type: object
VolumeSource:
additionalProperties: false
description: The source specification for a volume mount.
properties:
volume_type:
description: The type of volume.
example: nfs
type: string
nfs_host:
description: The NFS host. Required when `volume_type` is `nfs`.
nullable: true
type: string
nfs_export_path:
description: The NFS export path. Required when `volume_type` is `nfs`.
nullable: true
type: string
pvc_name:
description: The PersistentVolumeClaim name. Required when `volume_type` is `pvc`.
nullable: true
type: string
type: object
securitySchemes:
apiKey:
description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.
'
in: header
name: Authorization
type: apiKey