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/signadot:signadot-resourceplugins-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:
  contact: {}
  description: API for Signadot Sandboxes
  title: Signadot Resource Plugins API
  version: '2.0'
servers:
- url: https://api.signadot.com/api/v2
tags:
- name: ResourcePlugins
paths:
  /orgs/{orgName}/resource-plugins:
    get:
      description: List resource plugins under the specified Signadot org. By default returns only the highest-semver version of each plugin. Pass `?version=all` to expand the response into one row per published (name, version), sorted by name then semver-descending. `?version=latest` is accepted as an explicit alias for the default.
      operationId: list-resource-plugins
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: '''latest'' (default) returns only the highest-semver version of each plugin; ''all'' returns every published version'
        in: query
        name: version
        schema:
          type: string
          enum:
          - latest
          - all
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ResourcePlugin'
                type: array
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List resource plugins
      tags:
      - ResourcePlugins
  /orgs/{orgName}/resource-plugins/{pluginName}:
    delete:
      description: Delete a resource plugin version. Omit the version query parameter to delete the latest version. Deletion is blocked when any sandbox references the specific version being deleted.
      operationId: delete-resource-plugin
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Resource plugin name
        in: path
        name: pluginName
        required: true
        x-example: mariadb-plugin
        schema:
          type: string
      - description: Resource plugin version (semver); omit for latest
        in: query
        name: version
        x-example: 1.2.0
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Delete a resource plugin
      tags:
      - ResourcePlugins
    get:
      description: Get the specified resource plugin. Omit the version query parameter to get the latest version.
      operationId: get-resource-plugin
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Resource plugin name
        in: path
        name: pluginName
        required: true
        x-example: mariadb-plugin
        schema:
          type: string
      - description: Resource plugin version (semver); omit for latest
        in: query
        name: version
        x-example: 1.2.0
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcePlugin'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get the requested resource plugin
      tags:
      - ResourcePlugins
    put:
      description: Creates a new version of a resource plugin. The body's `name` field carries the wire form `bareName[@semver]` (e.g. `my-plugin@1.2.0`); its bare part must match the URL path name. A bare-name form (no `@`) publishes the default version `0.0.0`. Versions are immutable; PUTting an existing (name, version) pair returns 409. The version suffix must be a concrete semver; "latest" is only accepted on the read and delete query parameters.
      operationId: apply-resource-plugin
      parameters:
      - description: Signadot Org Name
        in: path
        name: orgName
        required: true
        x-example: my-company
        schema:
          type: string
      - description: Resource plugin name
        in: path
        name: pluginName
        required: true
        x-example: mariadb-plugin
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Apply a resource plugin
      tags:
      - ResourcePlugins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourcePlugin'
        description: Request to create a resource plugin version
        required: true
components:
  schemas:
    resourceplugin.StepInputTo:
      properties:
        env:
          description: 'Inject the input as an env variable with name Env inside the

            main container'
          type: string
        path:
          description: Expose the input as a file at Path inside the main container
          type: string
      type: object
    resourceplugin.Spec:
      properties:
        create:
          description: Create refers to the `create` steps for spinning up the resource
          items:
            $ref: '#/components/schemas/resourceplugin.Step'
          type: array
        delete:
          description: Delete refers to the `delete` steps for spinning up the resource
          items:
            $ref: '#/components/schemas/resourceplugin.Step'
          type: array
        description:
          description: Description for the resource
          type: string
        runner:
          allOf:
          - $ref: '#/components/schemas/resourceplugin.Runner'
          description: Runner for the resource plugin
      type: object
    ErrorResponse:
      properties:
        code:
          type: integer
        error:
          type: string
        requestId:
          type: string
      type: object
    ResourceInfo:
      properties:
        cluster:
          description: Cluster that the resource is created in
          type: string
        name:
          description: Name of the created resource
          type: string
        sandbox:
          description: Name of the sandbox containing the resource
          type: string
      type: object
    resourceplugin.ValueFromStep:
      properties:
        name:
          description: Name of the step
          type: string
        output:
          description: Name of the variable from the step
          type: string
      type: object
    resourceplugin.StepInput:
      properties:
        as:
          allOf:
          - $ref: '#/components/schemas/resourceplugin.StepInputTo'
          description: 'If the As field is not speficied, we will take the input name

            uppercase it, convert "-" to "_", and inject it as an env var into

            the main container'
        name:
          description: Name for the input
          type: string
        type:
          description: Type of input
          type: string
        valueFromSandbox:
          description: ValueFromSandbox defines whether or not to source value from the sandbox spec
          type: boolean
        valueFromStep:
          allOf:
          - $ref: '#/components/schemas/resourceplugin.ValueFromStep'
          description: 'ValueFromStep is an optional string specifying the output of

            another step when not nil.  Exactly one of ValueFromSandbox

            and ''ValueFromStep != nil'' must hold.'
      type: object
    EmptyResponse:
      type: object
    resourceplugin.Step:
      properties:
        inputs:
          description: Inputs for the step
          items:
            $ref: '#/components/schemas/resourceplugin.StepInput'
          type: array
        name:
          description: Name for the step
          type: string
        outputs:
          description: Outputs for the step
          items:
            $ref: '#/components/schemas/resourceplugin.StepOut'
          type: array
        script:
          description: Script to execute in the step
          type: string
      type: object
    resourceplugin.Runner:
      properties:
        image:
          description: Image for the runner instance
          type: string
        namespace:
          description: Namespace to create this runner instance in
          type: string
        podTemplateOverlay:
          description: Pod template overlay
          type: string
      type: object
    resourceplugin.Status:
      properties:
        resources:
          description: Resources created using the resource plugin
          items:
            $ref: '#/components/schemas/ResourceInfo'
          type: array
      type: object
    ResourcePlugin:
      properties:
        createdAt:
          description: The time at which the resource plugin was created
          type: string
        name:
          description: 'Plugin identity of the form `bareName[@semver]`. The bare-name

            form (no `@`) means the default version (0.0.0); responses

            for plugins at the default version use this bare form for

            backward compatibility with pre-versioning clients.'
          example: my-plugin@1.2.0
          type: string
        spec:
          allOf:
          - $ref: '#/components/schemas/resourceplugin.Spec'
          description: Specification for the resource plugin
        status:
          allOf:
          - $ref: '#/components/schemas/resourceplugin.Status'
          description: Status of the resource plugin
        updatedAt:
          description: The time at which the resource plugin was last updated
          type: string
      type: object
    resourceplugin.StepOut:
      properties:
        description:
          description: Description for the output
          type: string
        name:
          description: Name of the output variable
          type: string
        type:
          description: Type of output
          type: string
        valueFromPath:
          description: Path within the main container from where the output will be read
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: signadot-api-key
      type: apiKey