Bigeye

Bigeye Named Schedule Service API

The NamedScheduleService API from Bigeye — 3 operation(s) for namedscheduleservice.

GitHub OpenAPI

Operations 4

DELETE /api/v1/schedules/{scheduleId} Deleted a named schedule #
GET /api/v1/schedules Get named schedules #
POST /api/v1/schedules Create a named schedule #
GET /api/v1/schedules/{scheduleId}/entities Get all entities using a given named schedule #

Documentation

📖
Documentation
https://docs.bigeye.com/docs/api-user-guide
📖
APIReference
https://docs.bigeye.com/reference
📖
Documentation
https://docs.bigeye.com/docs/monitoring
📖
Documentation
https://docs.bigeye.com/docs/getting-started-scanning

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-namedscheduleservice-api-openapi.yml

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/bigeye:bigeye-namedscheduleservice-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

bigeye-namedscheduleservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Metadata Named Schedule Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: NamedScheduleService
paths:
  /api/v1/schedules/{scheduleId}:
    delete:
      operationId: NamedScheduleService_DeleteNamedSchedule
      parameters:
      - in: path
        name: scheduleId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedEmpty'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Deleted a named schedule
      tags:
      - NamedScheduleService
  /api/v1/schedules:
    get:
      operationId: NamedScheduleService_GetNamedSchedule
      parameters:
      - in: query
        name: ids
        required: false
        explode: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      - in: query
        name: pageSize
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        name: pageCursor
        required: false
        schema:
          type: string
      - in: query
        name: sortField
        required: false
        schema:
          type: string
          enum:
          - NAMED_SCHEDULE_SORT_UNSPECIFIED
          - NAMED_SCHEDULE_SORT_NAME
          default: NAMED_SCHEDULE_SORT_UNSPECIFIED
      - in: query
        name: sortDirection
        required: false
        schema:
          type: string
          enum:
          - SORT_DIRECTION_UNSPECIFIED
          - SORT_DIRECTION_ASCENDING
          - SORT_DIRECTION_DESCENDING
          default: SORT_DIRECTION_UNSPECIFIED
      - in: query
        name: search
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetNamedSchedulesResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get named schedules
      tags:
      - NamedScheduleService
    post:
      operationId: NamedScheduleService_CreateNamedSchedule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedCreateNamedScheduleRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedNamedSchedule'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Create a named schedule
      tags:
      - NamedScheduleService
  /api/v1/schedules/{scheduleId}/entities:
    get:
      operationId: NamedScheduleService_GetNamedScheduleEntities
      parameters:
      - in: path
        name: scheduleId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetNamedScheduleEntitiesResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get all entities using a given named schedule
      tags:
      - NamedScheduleService
components:
  schemas:
    generatedEmpty:
      type: object
    protobufAny:
      properties:
        typeUrl:
          type: string
        value:
          format: byte
          type: string
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedPaginationInfo:
      properties:
        firstSortDistinctValues:
          format: int64
          type: string
        nextCursor:
          type: string
        noNumRecords:
          type: boolean
        numRecords:
          format: int32
          type: integer
        prevCursor:
          type: string
      type: object
    generatedGetNamedSchedulesResponse:
      properties:
        namedSchedules:
          items:
            $ref: '#/components/schemas/generatedNamedSchedule'
          type: array
        paginationInfo:
          $ref: '#/components/schemas/generatedPaginationInfo'
      type: object
    generatedNamedSchedule:
      properties:
        cron:
          type: string
        entityInfo:
          $ref: '#/components/schemas/generatedEntityInfo'
        id:
          format: int32
          type: integer
        name:
          type: string
        timezone:
          description: IANA timezone id (e.g. "America/New_York") used to interpret the cron. Defaults to UTC when unset.
          type: string
      type: object
    generatedEntityInfo:
      properties:
        createdBy:
          format: int32
          type: integer
        createdEpochSeconds:
          format: int64
          type: string
        updatedBy:
          format: int32
          type: integer
        updatedEpochSeconds:
          format: int64
          type: string
      type: object
    generatedCreateNamedScheduleRequest:
      properties:
        cron:
          type: string
        id:
          format: int32
          type: integer
        name:
          type: string
        timezone:
          description: IANA timezone id (e.g. "America/New_York") used to interpret the cron. Defaults to UTC when unset.
          type: string
        workspaceId:
          format: int32
          type: integer
      type: object
    generatedIdAndDisplayName:
      properties:
        displayName:
          type: string
        id:
          format: int32
          type: integer
      type: object
    generatedGetNamedScheduleEntitiesResponse:
      properties:
        metrics:
          items:
            $ref: '#/components/schemas/generatedIdAndDisplayName'
          type: array
        tableComparisons:
          items:
            $ref: '#/components/schemas/generatedIdAndDisplayName'
          type: array
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Agent_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
    Personal_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  method: harvested
  publisher: Bigeye
  source: https://docs.bigeye.com/openapi/metadata.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)