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/stackit:stackit-v2beta-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

openapi: 3.2.0
info:
  contact:
    email: support@stackit.de
  description: API endpoints for the STACKIT Run Commands Service API
  termsOfService: https://stackit.de/en/imprint
  title: STACKIT Run Commands Service V2beta API
  version: 2beta.0
servers:
- url: https://run-command.api.stackit.cloud
  variables:
    region:
      default: global
security:
- bearerAuth: []
tags:
- name: V2beta
paths:
  /v2beta/command-templates:
    get:
      description: Returns a list of command templates
      operationId: ListCommandTemplates
      parameters:
      - description: The type of the Operating System (windows or linux). If not provided will return data for all OS types.
        in: query
        name: osType
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                commandTemplatesExample:
                  $ref: '#/components/examples/commandTemplatesResponseExample'
              schema:
                $ref: '#/components/schemas/CommandTemplateResponse'
          description: response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
      security: []
      x-stackit-authorization:
        disabled: true
      tags:
      - V2beta
      summary: List command templates
      x-summary-source: derived
  /v2beta/projects/{projectId}/regions/{region}/servers/{serverId}/command-templates/{commandTemplateName}:
    get:
      description: Returns details about a command template
      operationId: GetCommandTemplate
      parameters:
      - description: ID of the project
        explode: false
        in: path
        name: projectId
        required: true
        schema:
          type: string
        style: simple
      - description: Server ID of the machine
        explode: false
        in: path
        name: serverId
        required: true
        schema:
          type: string
        style: simple
      - description: Name of the template
        explode: false
        in: path
        name: commandTemplateName
        required: true
        schema:
          type: string
        style: simple
      - description: region
        in: path
        name: region
        required: true
        schema:
          description: Name of the region.
          example: eu01
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                runShellTemplateExample:
                  $ref: '#/components/examples/runShellTemplateResponseExample'
              schema:
                $ref: '#/components/schemas/CommandTemplateSchema'
          description: response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
      x-stackit-authorization:
        actions:
        - run-command.command-template.get
        resource-id: projectId
        resource-id-type: dynamic
        resource-type: project
      tags:
      - V2beta
      summary: Get command template
      x-summary-source: derived
  /v2beta/projects/{projectId}/regions/{region}/servers/{serverId}/commands:
    get:
      description: Returns a list of commands
      operationId: ListCommands
      parameters:
      - description: ID of the project
        explode: false
        in: path
        name: projectId
        required: true
        schema:
          type: string
        style: simple
      - description: Server ID of the machine
        explode: false
        in: path
        name: serverId
        required: true
        schema:
          type: string
        style: simple
      - description: region
        in: path
        name: region
        required: true
        schema:
          description: Name of the region.
          example: eu01
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                commandsResponseExample:
                  $ref: '#/components/examples/commandsResponseExample'
              schema:
                $ref: '#/components/schemas/GetCommandsResponse'
          description: response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
      x-stackit-authorization:
        actions:
        - run-command.command.list
        resource-id: projectId
        resource-id-type: dynamic
        resource-type: project
      tags:
      - V2beta
      summary: List commands
      x-summary-source: derived
    post:
      description: Creates a new command for execution
      operationId: CreateCommand
      parameters:
      - description: ID of the project
        explode: false
        in: path
        name: projectId
        required: true
        schema:
          type: string
        style: simple
      - description: Server ID of the machine
        explode: false
        in: path
        name: serverId
        required: true
        schema:
          type: string
        style: simple
      - description: region
        in: path
        name: region
        required: true
        schema:
          description: Name of the region.
          example: eu01
          type: string
      requestBody:
        content:
          application/json:
            examples:
              RunShellScript:
                $ref: '#/components/examples/RunShellScriptCommandRequestExample'
              winResetPass:
                $ref: '#/components/examples/winResetPassCommandRequestExample'
            schema:
              $ref: '#/components/schemas/CreateCommandPayload'
        description: Command to post
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewCommandResponse'
          description: ok
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
      x-stackit-authorization:
        actions:
        - run-command.command.create
        resource-id: projectId
        resource-id-type: dynamic
        resource-type: project
        service-enablement:
          services:
          - cloud.stackit.run-command
      tags:
      - V2beta
      summary: Create command
      x-summary-source: derived
  /v2beta/projects/{projectId}/regions/{region}/servers/{serverId}/commands/{commandId}:
    get:
      description: Returns details about a command
      operationId: GetCommand
      parameters:
      - description: ID of the project
        explode: false
        in: path
        name: projectId
        required: true
        schema:
          type: string
        style: simple
      - description: region
        in: path
        name: region
        required: true
        schema:
          description: Name of the region.
          example: eu01
          type: string
      - description: Server ID of the machine
        explode: false
        in: path
        name: serverId
        required: true
        schema:
          type: string
        style: simple
      - description: ID of the command
        explode: false
        in: path
        name: commandId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              examples:
                commandDetailsResponseExample:
                  $ref: '#/components/examples/commandDetailsResponseExample'
              schema:
                $ref: '#/components/schemas/CommandDetails'
          description: response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
      x-stackit-authorization:
        actions:
        - run-command.command.get
        resource-id: projectId
        resource-id-type: dynamic
        resource-type: project
      tags:
      - V2beta
      summary: Get command
      x-summary-source: derived
components:
  examples:
    commandDetailsResponseExample:
      value:
        commandTemplateName: RunShellScript
        commandTemplateTitle: Run Shell Script
        exitCode: 0
        finishedAt: ''
        id: 1
        output: ''
        script: echo hello
        startedAt: '2023-06-14T09:54:57Z'
        status: pending
    RunShellScriptCommandRequestExample:
      summary: Run Shell Script
      value:
        commandTemplateName: RunShellScript
        parameters:
          script: echo hello-world
    commandTemplatesResponseExample:
      value:
        items:
        - name: RunShellScript
          osType:
          - linux
          title: Run Shell Script
    runShellTemplateResponseExample:
      value:
        description: Run Custom Shell Script
        name: RunShellScript
        osType:
        - linux
        parametersSchema:
          properties:
            script:
              title: Script
              type: string
        title: Run Shell Script
    commandsResponseExample:
      value:
        items:
        - commandTemplateName: RunShellScript
          commandTemplateTitle: Run Shell Script
          finishedAt: ''
          id: 1
          startedAt: '2023-06-14T09:54:57Z'
          status: pending
    winResetPassCommandRequestExample:
      summary: Windows Reset Password
      value:
        commandTemplateName: ResetPassword
        parameters:
          password: '********'
          username: username
  schemas:
    CommandTemplateSchema:
      properties:
        description:
          type: string
        name:
          type: string
        osType:
          items:
            type: string
          type: array
        parameterSchema:
          $ref: '#/components/schemas/ParametersSchema'
        title:
          type: string
      type: object
    ErrorResponse:
      properties:
        message:
          description: Details about the error
          type: string
        status:
          description: The string representation of the http status code (i.e. Not Found, Bad Request, etc)
          type: string
      required:
      - status
      - message
      type: object
    CommandTemplateResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CommandTemplate'
          type: array
      type: object
    GetCommandsResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Commands'
          type: array
      type: object
    NewCommandResponse:
      properties:
        id:
          format: int32
          type: integer
      type: object
    CommandDetails:
      properties:
        commandTemplateName:
          type: string
        commandTemplateTitle:
          type: string
        exitCode:
          format: int32
          type: integer
        finishedAt:
          type: string
        id:
          format: int32
          type: integer
        output:
          type: string
        script:
          type: string
        startedAt:
          type: string
        status:
          enum:
          - pending
          - running
          - completed
          - failed
          type: string
      type: object
    CreateCommandPayload:
      properties:
        commandTemplateName:
          type: string
        parameters:
          additionalProperties:
            type: string
          type: object
      required:
      - commandTemplateName
      type: object
    ParametersSchema:
      properties:
        properties:
          $ref: '#/components/schemas/Properties'
      type: object
    Field:
      properties:
        default:
          type: string
        description:
          type: string
        maxLen:
          format: int32
          type: integer
        minLen:
          format: int32
          type: integer
        readOnly:
          type: boolean
        title:
          type: string
        type:
          type: string
      type: object
    CommandTemplate:
      properties:
        name:
          type: string
        osType:
          items:
            type: string
          type: array
        title:
          type: string
      type: object
    Commands:
      properties:
        commandTemplateName:
          type: string
        commandTemplateTitle:
          type: string
        finishedAt:
          type: string
        id:
          format: int32
          type: integer
        startedAt:
          type: string
        status:
          enum:
          - pending
          - running
          - completed
          - failed
          type: string
      type: object
    Properties:
      properties:
        ConfirmPassword:
          $ref: '#/components/schemas/Field'
        Password:
          $ref: '#/components/schemas/Field'
        Script:
          $ref: '#/components/schemas/Field'
        Username:
          $ref: '#/components/schemas/Field'
        required:
          items:
            type: string
          type: array
        type:
          type: string
      type: object