SKRIME Instance API

TeamSpeak Instanz

GitHub OpenAPI

Operations 3

GET /instance/statistic Statistiken abrufen #
GET /instance/whitelist Whitelist abrufen #
GET /instance/virtualserver Virtuelle Server abrufen #

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/skrime:skrime-instance-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

skrime-instance-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: SKRIME API (read only) Instance API
  version: ee58e62caf7f
  description: Reading endpoints of the SKRIME API without secrets. Descriptions in German, structure in English.
  termsOfService: https://skrime.eu/tos
  contact:
    name: SKRIME
    url: https://skrime.eu/
    email: vertrieb@skrime.eu
servers:
- url: https://skrime.eu/sandbox
  description: 'Sandbox: validates like the live API, answers with test data, changes nothing and costs nothing'
- url: https://skrime.eu/api
  description: Live
security:
- bearerAuth: []
tags:
- name: Instance
  description: TeamSpeak Instanz
paths:
  /instance/statistic:
    get:
      operationId: get_instance_statistic
      summary: Statistiken abrufen
      tags:
      - Instance
      x-skrime-risk: L
      parameters:
      - name: productId
        in: query
        required: true
        schema:
          type: string
        example: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
              examples:
                example:
                  summary: Statistiken abrufen
                  value:
                    response: Successfully fetched instance statistics
                    state: success
                    data:
                      productId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
                      currentSlots: '32'
                      averageSlots: '16'
                      reservedAmount: '0.00'
                      charts:
                        slots:
                        - x: '2024-01-01'
                          y: 32
                        - x: '2024-01-01'
                          y: 28
                        packetloss:
                        - x: '2024-01-01'
                          y: 0.02
                        - x: '2024-01-01'
                          y: 0.14
                      period:
                        start: '2024-01-01'
                        end: '2024-01-01'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '423':
          $ref: '#/components/responses/Locked'
  /instance/whitelist:
    get:
      operationId: get_instance_whitelist
      summary: Whitelist abrufen
      tags:
      - Instance
      x-skrime-risk: L
      parameters:
      - name: productId
        in: query
        required: true
        schema:
          type: string
        example: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
              examples:
                example:
                  summary: Whitelist abrufen
                  value:
                    response: Successfully fetched whitelist
                    state: success
                    data:
                      productId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
                      whitelist:
                      - 127.0.0.1
                      - 127.0.0.1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '423':
          $ref: '#/components/responses/Locked'
  /instance/virtualserver:
    get:
      operationId: get_instance_virtualserver
      summary: Virtuelle Server abrufen
      tags:
      - Instance
      x-skrime-risk: L
      parameters:
      - name: productId
        in: query
        required: true
        schema:
          type: string
        example: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
              examples:
                example:
                  summary: Virtuelle Server abrufen
                  value:
                    response: Successfully fetched virtualservers
                    state: success
                    data:
                      productId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
                      virtualservers:
                      - virtualserver: zaWi3hcOPJcQBLZwGFrvOnDmeCY=
                        createdAt: '2024-01-01 00:00:00'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '423':
          $ref: '#/components/responses/Locked'
components:
  responses:
    Unauthorized:
      description: The API key is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            response: Unauthorized access, please log in or provide a valid key
            state: error
            data: []
    Forbidden:
      description: Missing permission, interface required or multi factor authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            response: Unauthorized access, please check your permissions
            state: error
            data: []
    BadRequest:
      description: 'Invalid request: a field is missing or a value is invalid'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            response: Invalid request, please provide a productId
            state: error
            data: []
    Locked:
      description: Access is blocked because the product is suspended, data.reason names the reason
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            response: Access blocked due to product suspension
            state: error
            data:
              reason: Payment overdue
    NotFound:
      description: The requested record does not exist or is inactive
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            response: No product found or product is suspended
            state: error
            data: []
  schemas:
    Envelope:
      type: object
      required:
      - response
      - state
      - data
      properties:
        response:
          type: string
          description: English message, stable per case
        state:
          type: string
          enum:
          - success
          - error
        data:
          description: Payload, an empty array when there is none
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the SKRIME dashboard, read it from the environment variable SKRIME_API_KEY