Posit

Posit System Checks API

The System Checks API from Posit — 3 operation(s) for system checks.

GitHub OpenAPI

Operations 5

GET /v1/system/checks List system check runs #
POST /v1/system/checks Start a system check run #
DELETE /v1/system/checks/{id} Delete a system check run #
GET /v1/system/checks/{id} Get the status of a system check run #
GET /v1/system/checks/{id}/results Get the results of a system check run #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/posit/refs/heads/main/openapi/posit-system-checks-api-openapi.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/posit-system-checks-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

posit-system-checks-api-openapi.yml Raw ↑ 
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 System Checks API
  version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: System Checks
paths:
  /v1/system/checks:
    get:
      description: 'List all system check runs that have been requested.

        You must have administrator privileges to perform this action.'
      operationId: listSystemCheckRuns
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SystemCheckRun'
                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 system check runs
      tags:
      - System Checks
    post:
      description: 'Start a system check run. The tests run in the background, and you can

        poll for status using the returned run ID.

        You must have administrator privileges to perform this action.'
      operationId: runSystemChecks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRunInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemCheckRun'
          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: Start a system check run
      tags:
      - System Checks
  /v1/system/checks/{id}:
    delete:
      description: Delete a system check run and the associated results.
      operationId: deleteSystemCheckRun
      parameters:
      - 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 a system check run
      tags:
      - System Checks
    get:
      description: Get the status of a system check run.
      operationId: getSystemCheckRun
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemCheckRun'
          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 the status of a system check run
      tags:
      - System Checks
  /v1/system/checks/{id}/results:
    get:
      description: Get the results of a system check run.
      operationId: getSystemCheckRunResults
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemCheckRunResults'
          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 the results of a system check run
      tags:
      - System Checks
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
    SystemCheckRun:
      additionalProperties: false
      description: The fields returned when listing system check runs or getting the status of a run.
      properties:
        id:
          description: The unique identifier for this test run.
          example: '2'
          type: string
        start_time:
          description: The timestamp (RFC3339) of when this run was started.
          example: '2006-01-02T15:04:05-07:00'
          format: date-time
          type: string
        hostname:
          description: The hostname where this test was run.
          example: connect.example.com
          type: string
        status:
          description: 'The status of this test run, one of: requested, running, done, canceled.'
          enum:
          - requested
          - running
          - done
          - canceled
          example: done
          type: string
        passed:
          description: The number of tests in this run that have passed.
          example: 29
          format: int32
          type: integer
        failed:
          description: The number of tests in this run that have failed.
          example: 1
          format: int32
          type: integer
      type: object
    SystemCheckRunResults:
      additionalProperties: false
      description: Fields containing results of a specific system check run.
      properties:
        run:
          allOf:
          - $ref: '#/components/schemas/SystemCheckRun'
          description: The run that was requested.
        results:
          description: The results of the system check run.
          items:
            $ref: '#/components/schemas/SystemCheckRunResult'
          type: array
      type: object
    TestInfo:
      additionalProperties: false
      description: Fields describing a specific test or test group.
      properties:
        name:
          description: The name of this test.
          example: environment
          type: string
        args:
          description: The arguments that will be passed to this test.
          type: string
      type: object
    CreateRunInput:
      additionalProperties: false
      description: The fields to provide when running system checks.
      properties:
        hostname:
          description: The hostname where this test was run. Optional. Defaults to the host
          example: connect.example.com
          type:
          - string
          - 'null'
      type: object
    SystemCheckRunResult:
      additionalProperties: false
      description: The fields describing a single system check result.
      properties:
        group:
          allOf:
          - $ref: '#/components/schemas/TestInfo'
          description: Information about the test group that was run.
        test:
          allOf:
          - $ref: '#/components/schemas/TestInfo'
          description: Information about the test that was run.
        passed:
          description: Boolean indicating whether the test passed.
          example: true
          type: boolean
        output:
          description: The textual output produced while running the test.
          type: string
        error:
          description: The error that occurred while running this test, or empty string if no error occurred.
          type: string
      type: object
  securitySchemes:
    apiKey:
      description: 'Prefix your API key with `Key `, e.g. `Key ABC123`.

        '
      in: header
      name: Authorization
      type: apiKey