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/4chems-com:4chems-com-infra-operations-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: platform-api Infra Operations API
  description: 'Platform API: infrastructure, operational, and customer tiers.'
  version: 0.12.1
tags:
- name: infra-operations
paths:
  /infra/operations/:
    get:
      tags:
      - infra-operations
      summary: List Ops
      description: 'List async operations across every tier, optionally filtered by status, type,

        tenant, or actor. Call this when an operator needs to triage the infra operations

        queue, e.g. to find stuck or failed operations to retry or cancel.'
      operationId: list_infra_operations
      security:
      - HTTPBearer: []
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/OperationStatus'
          - type: 'null'
          title: Status
      - name: type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
      - name: tier
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/OperationTier'
          - type: 'null'
          title: Tier
      - name: tenant
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant
      - name: actor_sub
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actor Sub
      - name: created_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created Before
      - name: created_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created After
      - name: stuck
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Stuck
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationListOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /infra/operations/{operation_id}:
    get:
      tags:
      - infra-operations
      summary: Get Op
      description: 'Return one operation''s full status, result, and error detail. Call this to

        inspect a specific operation before deciding whether to retry or cancel it.'
      operationId: get_infra_operation
      security:
      - HTTPBearer: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Operation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationInfraOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /infra/operations/{operation_id}/retry:
    post:
      tags:
      - infra-operations
      summary: Retry Op
      description: 'Reset a failed operation to pending so the worker picks it up again and return

        its new status. Call this when an operator has fixed the underlying cause of a

        failed operation and wants it re-attempted.'
      operationId: retry_operation
      security:
      - HTTPBearer: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Operation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationInfraOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /infra/operations/{operation_id}/cancel:
    post:
      tags:
      - infra-operations
      summary: Cancel Op
      description: 'Cancel a pending or running operation and return its new status. Call this

        when an operator wants to stop an operation that should no longer proceed.'
      operationId: cancel_operation
      security:
      - HTTPBearer: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Operation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationInfraOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OperationInfraOut:
      properties:
        operation_id:
          type: string
          format: uuid
          title: Operation Id
        status:
          type: string
          title: Status
        type:
          type: string
          title: Type
        tier:
          type: string
          title: Tier
        tenant:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant
        actor_sub:
          type: string
          title: Actor Sub
        target_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Type
        target_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Id
        result:
          anyOf:
          - {}
          - type: 'null'
          title: Result
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        attempts:
          type: integer
          title: Attempts
        max_attempts:
          type: integer
          title: Max Attempts
        cancel_requested:
          type: boolean
          title: Cancel Requested
        retried_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Retried By
        cancelled_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Cancelled By
        locked_until:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Locked Until
        created_at:
          type: string
          format: date-time
          title: Created At
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        finished_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
      type: object
      required:
      - operation_id
      - status
      - type
      - tier
      - actor_sub
      - attempts
      - max_attempts
      - cancel_requested
      - created_at
      title: OperationInfraOut
      description: 'Full detail schema for the /infra operations console (UC-022).


        Intentionally excludes idempotency_key — it is a caller secret.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      type: object
      required:
      - code
      - message
      title: ErrorDetail
    OperationTier:
      type: string
      enum:
      - ops
      - infra
      - v1
      title: OperationTier
    OperationStatus:
      type: string
      enum:
      - pending
      - running
      - succeeded
      - failed
      - cancelled
      title: OperationStatus
    OperationListOut:
      properties:
        items:
          items:
            $ref: '#/components/schemas/OperationInfraOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        offset:
          type: integer
          title: Offset
        limit:
          type: integer
          title: Limit
      type: object
      required:
      - items
      - total
      - offset
      - limit
      title: OperationListOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer