Posit API Keys API
The API Keys API from Posit — 2 operation(s) for api keys.
The API Keys API from Posit — 2 operation(s) for api keys.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/posit-api-keys-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 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 API Keys API
version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: API Keys
paths:
/v1/users/{guid}/keys:
get:
description: List your provisioned API keys.
operationId: listKeys
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/APIKey'
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.
'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 API keys
tags:
- API Keys
post:
description: 'Create an API key.
Users can only create API keys for themselves. If `guid` does not match
the current user''s GUID, a 403 status is returned.'
operationId: createKey
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/APIKeyCreateInput'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/APIKey'
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 an API key
tags:
- API Keys
/v1/users/{guid}/keys/{id}:
delete:
description: Delete a single API key.
operationId: deleteKey
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
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.
'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: Delete an API key
tags:
- API Keys
get:
description: Get details for a single API key.
operationId: getKey
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/APIKey'
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.
'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 an API key
tags:
- API Keys
components:
schemas:
APIKeyCreateInput:
additionalProperties: false
description: An object sent to create an API key.
properties:
name:
description: 'The name for this API key. Use the name to describe the purpose of
the key.'
example: Automation
type: string
user_role:
description: 'The role of this API key. Cannot be greater than the role of the
user account. Defaults to the user account role when `null`.'
enum:
- administrator
- publisher
- viewer
example: viewer
type: string
expires_at:
description: 'Optional timestamp (in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format) indicating when the key expires. After this time, the key
can no longer authenticate and is removed automatically. Must be in
the future. Omit or set to `null` for a key that never expires.'
example: '2026-12-31T00:00:00Z'
format: date-time
type:
- string
- 'null'
type: object
APIKey:
additionalProperties: false
description: Object containing API key details.
properties:
id:
description: The unique identifier for this API key.
example: '2'
type: string
name:
description: 'The name for this API key. The name often describes the purpose of
the key.'
example: Automation
type: string
key:
description: 'The secret text for this API key. The full key is only revealed when
the key is created. Subsequent reads only reveal the last few
characters.'
example: abcdefgabcdefg
type: string
user_role:
description: The role of this API key.
enum:
- administrator
- publisher
- viewer
example: viewer
type: string
created_time:
description: 'Timestamp (in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format) indicating when the key was created.'
example: '2006-01-02T15:04:05-07:00'
format: date-time
type: string
active_time:
description: 'Timestamp (in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format) indicating approximately when the key was last used.
Highly active keys only receive periodic updates.'
example: '2006-01-02T15:04:05-07:00'
format: date-time
type: string
expires_at:
description: 'Timestamp (in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
format) indicating when the key expires, or `null` if the key never
expires.'
example: '2026-12-31T00:00:00Z'
format: date-time
type:
- string
- 'null'
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.
type:
- object
- 'null'
required:
- code
- error
type: object
securitySchemes:
apiKey:
description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.
'
in: header
name: Authorization
type: apiKey