How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Posit System Checks API

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

Posit System Checks API is one of 33 APIs that Posit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include System Checks. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against a single base URL, /__api__.

5 operations 3 paths 6 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://connect.example.com/__api__
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Posit System Checks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — Prefix your API key with Key , e.g. Key ABC123.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

System Checks 5
GET
/v1/system/checks
List system check runs
listSystemCheckRuns → 200400401404500
POST
/v1/system/checks
Start a system check run
runSystemChecks body → 200400401404500
DELETE
/v1/system/checks/{id}
Delete a system check run
deleteSystemCheckRun 1 param → 204400401404500
GET
/v1/system/checks/{id}
Get the status of a system check run
getSystemCheckRun 1 param → 200400401404500
GET
/v1/system/checks/{id}/results
Get the results of a system check run
getSystemCheckRunResults 1 param → 200400401404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SystemCheckRun (6 properties), SystemCheckRunResult (5 properties), APIError (3 properties), SystemCheckRunResults (2 properties). Each schema is shown below with its type and property counts.

SystemCheckRun
object
The fields returned when listing system check runs or getting the status of a run.
6 properties
TestInfo
object
Fields describing a specific test or test group.
2 properties
SystemCheckRunResult
object
The fields describing a single system check result.
5 properties
APIError
object
The error object returned by the API on failure.
3 properties 2 required
SystemCheckRunResults
object
Fields containing results of a specific system check run.
2 properties
CreateRunInput
object
The fields to provide when running system checks.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posit-system-checks-api-openapi.yml Raw ↑

Other APIs Posit publishes across the network.

Posit API Keys API
Posit Audit Logs API
Posit Bookmarks API
Posit Bootstrap API
Posit Bundles API
Posit Content API
Posit Content Permissions API
Posit Custom Documentation API
Posit Environment Permissions API
Posit Environments API
Posit Examples API
Posit Feature Usage API
Where this information came from

This is an independent, third-party profile of Posit System Checks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.