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/puzaricloud-in:puzaricloud-in-partner-api-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:
  title: Vigil Partner API
  description: 'Uptime, API checks with assertions, cron heartbeats, SSL expiry, website change detection and status pages.


    Authenticate with `Authorization: Bearer ` (find your key under Settings). API access requires a paid plan.


    Alert integration recipes: Spike.sh (webhook body template with `"source": "vigil"`), Apprise (send Apprise notifications into alert ingestion), MCP server, OpenTelemetry.'
  version: 1.0.0
tags:
- name: Partner API
paths:
  /api/v1/partner/clients:
    post:
      tags:
      - Partner API
      summary: Create a client workspace (idempotent on external_id)
      operationId: create_client_api_v1_partner_clients_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientIn'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Partner API
      summary: List client workspaces with usage
      operationId: list_clients_api_v1_partner_clients_get
      parameters:
      - name: external_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: External Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/partner/clients/{client_id}:
    get:
      tags:
      - Partner API
      summary: One client workspace
      operationId: get_client_api_v1_partner_clients__client_id__get
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: integer
          title: Client Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Partner API
      summary: Rename, suspend or unsuspend a client
      operationId: patch_client_api_v1_partner_clients__client_id__patch
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: integer
          title: Client Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Partner API
      summary: Delete a client and everything in it
      operationId: delete_client_api_v1_partner_clients__client_id__delete
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: integer
          title: Client Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/partner/clients/{client_id}/login-link:
    post:
      tags:
      - Partner API
      summary: One-time 5-minute login URL into the client workspace
      operationId: login_link_api_v1_partner_clients__client_id__login_link_post
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: integer
          title: Client Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/LoginLinkIn'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/partner/usage:
    get:
      tags:
      - Partner API
      summary: Partner totals against the plan's caps
      operationId: usage_api_v1_partner_usage_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    ClientIn:
      properties:
        name:
          type: string
          maxLength: 120
          minLength: 1
          title: Name
          description: Shown in the partner's client list and inside the workspace
        external_id:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: External Id
          description: Your id for this client (e.g. WHMCS service id). Unique per partner; creating twice returns the same client.
        contact_email:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Contact Email
          description: Client contact; login links log this person in as a client admin
      type: object
      required:
      - name
      title: ClientIn
    LoginLinkIn:
      properties:
        contact_email:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Contact Email
          description: Overrides the client's stored contact for this link
      type: object
      title: LoginLinkIn
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ClientPatch:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 120
            minLength: 1
          - type: 'null'
          title: Name
        suspended:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Suspended
          description: true pauses every monitor and server and blocks logins; false restores
        contact_email:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Contact Email
      type: object
      title: ClientPatch
    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