Posit Storage API
The Storage API from Posit — 2 operation(s) for storage.
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 Storage API
version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: Storage
paths:
/v1/content/storage:
get:
description: 'Returns a paginated list of content items with their bundle storage
aggregates. Useful for identifying which content items consume the
most storage.
Results can be sorted by total bundle bytes, active bundle bytes,
inactive bundle bytes, or bundle count.
This endpoint requires authentication and is only available to users
with the `administrator` role.'
operationId: getContentStorageList
parameters:
- description: The page number to return.
in: query
name: page_number
schema:
default: 1
format: int64
type: integer
- description: The number of items per page.
in: query
name: page_size
schema:
default: 20
format: int64
type: integer
- description: The field to sort by.
in: query
name: sort
schema:
type: string
- description: 'The sort order: asc or desc.'
in: query
name: order
schema:
enum:
- asc
- desc
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentStorageList'
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: List content storage usage
tags:
- Storage
/v1/content/{guid}/storage:
get:
description: 'Returns detailed storage information for a specific content item,
including per-bundle size data.
This endpoint requires authentication and is only available to users
with the `administrator` role.'
operationId: getContentStorageDetail
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentStorageDetail'
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: Get content storage details
tags:
- Storage
components:
schemas:
ContentStorageListItemBundles:
additionalProperties: false
description: Bundle storage metrics for a content item.
properties:
count:
description: The number of bundles for this content item.
example: 14
type: integer
bytes_total:
description: Total bytes across all bundles for this content.
example: 1073741824
format: int64
type: integer
bytes_active:
description: Bytes used by the currently active (deployed) bundle.
example: 104857600
format: int64
type: integer
bytes_inactive:
description: Bytes used by inactive (historical) bundles.
example: 968884224
format: int64
type: integer
type: object
ContentBundleStorageDetail:
additionalProperties: false
description: Storage information for a single bundle.
properties:
id:
description: The identifier for this bundle.
example: '7'
type: string
created_time:
description: The timestamp (RFC3339) of when this bundle was created.
example: '2026-01-15T10:30:00Z'
format: date-time
type: string
size_bytes:
description: The size of the bundle archive in bytes.
example: 104857600
format: int64
type: integer
is_active:
description: Whether this is the currently deployed bundle.
example: true
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
ContentStorageList:
additionalProperties: false
description: Paginated list of content items with storage metrics.
properties:
results:
description: The list of content items for this page.
items:
$ref: '#/components/schemas/ContentStorageListItem'
type: array
current_page:
description: The current page number.
example: 1
format: int64
type: integer
total:
description: The total number of content items.
example: 542
type: integer
total_pages:
description: The total number of pages.
example: 28
type: integer
type: object
ContentStorageDetail:
additionalProperties: false
description: Detailed storage information for a content item, including per-bundle sizes.
properties:
content_guid:
description: The unique identifier of the content item.
example: abc12345-6789-0abc-def0-123456789abc
format: uuid
type: string
content_name:
description: The name of the content item.
example: My Dashboard
type: string
owner_guid:
description: The unique identifier of the content owner. Null if the content has no owner.
example: def45678-9012-3def-4567-890123456789
format: uuid
nullable: true
type: string
owner_username:
description: The username of the content owner. Null if the content has no owner.
example: jsmith
nullable: true
type: string
bundle_count:
description: The number of bundles for this content item.
example: 14
type: integer
bundle_bytes_total:
description: Total bytes across all bundles for this content.
example: 1073741824
format: int64
type: integer
bundle_bytes_active:
description: Bytes used by the currently active (deployed) bundle.
example: 104857600
format: int64
type: integer
bundle_bytes_inactive:
description: Bytes used by inactive (historical) bundles.
example: 968884224
format: int64
type: integer
bundles:
description: Per-bundle storage details, sorted by creation time (newest first).
items:
$ref: '#/components/schemas/ContentBundleStorageDetail'
type: array
type: object
ContentStorageListItem:
additionalProperties: false
description: Storage metrics for a single content item.
properties:
content_guid:
description: The unique identifier of the content item.
example: abc12345-6789-0abc-def0-123456789abc
format: uuid
type: string
content_name:
description: The URL-safe name of the content item.
example: my-dashboard
type: string
content_title:
description: The human-friendly title of the content item, or null if not set.
example: My Dashboard
nullable: true
type: string
owner_guid:
description: The unique identifier of the content owner, or null if the owner has been deleted.
example: def12345-6789-0abc-def0-123456789abc
format: uuid
nullable: true
type: string
owner_username:
description: The username of the content owner, or null if the owner has been deleted.
example: jsmith
nullable: true
type: string
app_mode:
description: The type of content (e.g., shiny, rmd, python-api).
example: shiny
type: string
bundles:
allOf:
- $ref: '#/components/schemas/ContentStorageListItemBundles'
description: Bundle storage metrics for this content item.
type: object
securitySchemes:
apiKey:
description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.
'
in: header
name: Authorization
type: apiKey