Overops UDFs API

Fetch and manipulate User Defined Functinos - OverOps extensions using Lambdas.

Operations 8

GET /global-settings/udfs List available UDF libraries
POST /global-settings/udfs Add a new UDF library
GET /global-settings/udfs/{library_id} Get UDF library properties
DELETE /global-settings/udfs/{library_id} Remove UDF library (TBD - Not yet implemented)
GET /services/{env_id}/udfs List available UDF libraries for the environment
POST /services/{env_id}/udfs Add a new UDF library
GET /services/{env_id}/udfs/{library_id} Get UDF library properties
DELETE /services/{env_id}/udfs/{library_id} Remove UDF library from the environment

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/overops-udfs-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.

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

OpenAPI Specification

overops-udfs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: v1
  title: Services Alerts UD Fs API
  contact:
    email: hello@overops.com
  description: "Main OverOps API.\nThe REST API layer enables OverOps admins and users to perform and automate all actions\nprovided by the OverOps UI available at https://app.overops.com (or On-premises equivalent URL) via a platform independent programmatic interface.\nA wrapper Java client API library that leverages these APIs for convenience by\nJava and Scala developers is available at https://github.com/takipi/api-client and on Maven Central.\n\nAll calls must be authenticated using one of the following methods:\n  1. Using `x-api-key` header (To generate the token, go to `Settings` --> `Account Settings` in the OverOps App). This is the recommended method.\n  2. Using Basic auth with `username:password` combo.\n"
servers:
- url: https://api.overops.com/api/v1
security:
- basicAuth: []
- ApiKeyAuth: []
tags:
- name: UDFs
  description: Fetch and manipulate User Defined Functinos - OverOps extensions using Lambdas.
paths:
  /global-settings/udfs:
    get:
      tags:
      - UDFs
      summary: List available UDF libraries
      description: List available UDF (User Defined Functions) libraries
      responses:
        '200':
          description: UDF libraries list
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UDFLibrary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
    post:
      tags:
      - UDFs
      summary: Add a new UDF library
      description: Add a new UDF library
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                udf:
                  type: string
                  format: binary
      responses:
        '200':
          $ref: '#/components/responses/OK'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
  /global-settings/udfs/{library_id}:
    get:
      tags:
      - UDFs
      summary: Get UDF library properties
      description: Get UDF (User Defined Function) library properties
      parameters:
      - in: path
        name: library_id
        description: UDF library ID to be used
        required: true
        schema:
          type: string
      responses:
        '200':
          description: UDF library properties
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UDFLibrary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
    delete:
      tags:
      - UDFs
      summary: Remove UDF library (TBD - Not yet implemented)
      description: Remove UDF library (TBD - Not yet implemented)
      parameters:
      - in: path
        name: library_id
        description: UDF library ID to be used
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OK'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /services/{env_id}/udfs:
    get:
      tags:
      - UDFs
      summary: List available UDF libraries for the environment
      description: List all available UDFs (User Defined Functions) for selected environment
      parameters:
      - in: path
        name: env_id
        description: Environment ID to use (e.g. S1234)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: UDF libraries list
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UDFLibrary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
    post:
      tags:
      - UDFs
      summary: Add a new UDF library
      description: Add a new UDF library
      parameters:
      - in: path
        name: env_id
        description: Environment ID to use (e.g. S1234)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: object
              properties:
                udf:
                  type: string
                  format: binary
      responses:
        '200':
          description: UDF library was successfully added
        '401':
          $ref: '#/components/responses/UnauthorizedError'
  /services/{env_id}/udfs/{library_id}:
    get:
      tags:
      - UDFs
      summary: Get UDF library properties
      description: Get UDF (User Defined Function) library properties
      parameters:
      - in: path
        name: env_id
        description: Environment ID to use (e.g. S1234)
        required: true
        schema:
          type: string
      - in: path
        name: library_id
        description: UDF library ID to be used
        required: true
        schema:
          type: string
      responses:
        '200':
          description: UDF properties
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UDFLibrary'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
    delete:
      tags:
      - UDFs
      summary: Remove UDF library from the environment
      description: Remove UDF library from specified environment
      parameters:
      - in: path
        name: env_id
        description: Environment ID to use (e.g. S1234)
        required: true
        schema:
          type: string
      - in: path
        name: library_id
        description: UDF library ID to be used
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OK'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  responses:
    UnauthorizedError:
      description: Unauthorized
    OK:
      description: OK
    NotFoundError:
      description: Not Found
  schemas:
    UDFLibrary:
      description: UDF Properties
      type: object
      properties:
        id:
          type: string
          example: L34
        version:
          type: string
          example: 1
        backward_compatible:
          type: string
          example: true
        functions:
          type: array
          items:
            $ref: '#/components/schemas/UDF'
    UDF:
      type: object
      properties:
        function_type:
          type: string
          example: ANOMALY
        short_description:
          type: string
          example: Relative Threshold
        long_description:
          type: string
          example: This function compares the volume of events against an absolute threshold
        param_type:
          type: string
          example: TEXT
        default_params:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                example: X
              default_value:
                type: string
                example: 100
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY