Skip to main content
Pulumi logo Pulumi logo
25.6K Contact us Sign in Dashboard Get started
  1. Docs
  2. Reference
  3. REST API Docs
  4. Miscellaneous

Miscellaneous

    Utility endpoints for checking service capabilities, retrieving the CLI version, exchanging OAuth tokens, and fetching the OpenAPI specification.

    Capabilities

    ▼
    GET /api/capabilities

    Returns the set of capabilities that the service supports.

    Responses

    200 OK
    Schema: AppCapabilitiesResponse
    • capabilities array[AppAPICapabilityConfig] required
      List of capabilities
    • ↳ capability enum required
      The capability identifier for this configuration entry.
      Values:
      delta-checkpoint-uploads — DeltaCheckpointUploads
      Deprecated. Use DeltaCheckpointUploadsV2.
      delta-checkpoint-uploads-v2 — DeltaCheckpointUploadsV2
      DeltaCheckpointUploads is the feature that enables the CLI to upload checkpoints via the PatchUpdateCheckpointDeltaRequest API to save on network bytes.
      batch-encrypt — BatchEncrypt
      Indicates that the service backend supports batch encryption.
      copilot-summarize-error — CopilotSummarizeError
      Indicates whether the service supports summarizing errors via Copilot.
      copilot-explain-preview — CopilotExplainPreview
      Indicates whether the service supports the Copilot explainer.
      deployment-schema-version — DeploymentSchemaVersion
      Indicates the maximum deployment schema version that the service supports.
      stack-policy-packs — StackPolicyPacks
      Indicates whether the service supports retrieving a stack’s required policy packs.
      api-version — APIVersion
      Advertises the REST API versions (the Accept: application/vnd.pulumi+N header) that the service supports. The configuration object carries maxVersion, minVersion, and defaultVersion.
      neo-cli-mode — NeoCLIMode
      Advertises that the service supports Neo CLI mode. The configuration object carries minCliVersion, the minimum pulumi CLI semver required to start a Neo CLI session.
    • ↳ version integer optional
      The version of this capability supported by the service.
    • ↳ configuration object optional
      Additional configuration data required for client integration with this capability.

    Version

    ▼
    GET /api/cli/version

    Returns version information about the CLI.

    Responses

    200 OK
    Schema: AppCLIVersionResponse
    • latestVersion string required
      The latest stable CLI version (semver string, e.g. ‘3.100.0’).
    • oldestWithoutWarning string required
      The oldest CLI version that will not show an upgrade warning.
    • latestDevVersion string required
      The latest development/pre-release CLI version.

    Fetch Rest Specification

    ▼
    GET /api/openapi/pulumi-spec.json

    Returns the OpenAPI v3 specification for the service.

    Responses

    200 OK

      The infrastructure as code platform for any cloud.

      Contact us Get started