Coralogix Scopes Service API

A service to manage scopes

Operations 5

GET /aaa/team-scopes/v1 Get Team Scopes By Ids #
PUT /aaa/team-scopes/v1 Update Scope #
POST /aaa/team-scopes/v1 Create Scope #
GET /aaa/team-scopes/v1/all/list Get Team Scopes #
DELETE /aaa/team-scopes/v1/{id} Delete Scope #

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/coralogix:coralogix-scopes-service-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

coralogix-scopes-service-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Coralogix Management Scopes Service API
  version: '5'
  description: 'Management API for the Coralogix observability platform. The base URL is region-specific: pick the `servers` entry matching your Coralogix domain. Authentication is a bearer API key.'
servers:
- url: https://api.eu1.coralogix.com/mgmt/openapi/5
- url: https://api.eu2.coralogix.com/mgmt/openapi/5
- url: https://api.us1.coralogix.com/mgmt/openapi/5
- url: https://api.us2.coralogix.com/mgmt/openapi/5
- url: https://api.us3.coralogix.com/mgmt/openapi/5
- url: https://api.ap1.coralogix.com/mgmt/openapi/5
- url: https://api.ap2.coralogix.com/mgmt/openapi/5
- url: https://api.ap3.coralogix.com/mgmt/openapi/5
- url: https://api.gov1.coralogixgov.us/mgmt/openapi/5
security:
- apiKeyAuth: []
tags:
- name: Scopes Service
  description: A service to manage scopes
paths:
  /aaa/team-scopes/v1:
    get:
      description: Returns a data access scope by ID.
      operationId: ScopesService_GetTeamScopesByIds
      parameters:
      - description: List of team scope identifiers to retrieve.
        in: query
        name: ids
        required: true
        schema:
          description: List of team scope identifiers to retrieve.
          items:
            description: List of team scope identifiers to retrieve.
            examples:
            - 60c82be2-413f-4b8e-8201-7f5c51e2ef2b
            minLength: 0
            type: string
          minItems: 0
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScopesResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Get Team Scopes By Ids
      tags:
      - Scopes Service
    put:
      description: Updates an existing data access scope.
      operationId: ScopesService_UpdateScope
      requestBody:
        content:
          application/json:
            schema:
              properties:
                defaultExpression:
                  description: The default expression.
                  examples:
                  - <v1>true
                  minLength: 0
                  type: string
                description:
                  description: Human-readable description.
                  examples:
                  - The best scope
                  minLength: 0
                  type: string
                  x-coralogix-presence: true
                displayName:
                  description: The display name.
                  examples:
                  - my-scope
                  minLength: 0
                  type: string
                filters:
                  description: List of filters.
                  items:
                    $ref: '#/components/schemas/scopes.v1.Filter'
                  minItems: 0
                  type: array
                id:
                  description: Unique identifier.
                  examples:
                  - 60c82be2-413f-4b8e-8201-7f5c51e2ef2b
                  minLength: 0
                  type: string
              required:
              - id
              - displayName
              - filters
              - defaultExpression
              title: Update Scope Request
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateScopeResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Update Scope
      tags:
      - Scopes Service
    post:
      description: Creates a new data access scope.
      operationId: ScopesService_CreateScope
      requestBody:
        content:
          application/json:
            schema:
              properties:
                defaultExpression:
                  description: The default expression.
                  examples:
                  - <v1>true
                  minLength: 0
                  type: string
                description:
                  description: Human-readable description.
                  examples:
                  - The best scope
                  minLength: 0
                  type: string
                  x-coralogix-presence: true
                displayName:
                  description: The display name.
                  examples:
                  - my-scope
                  minLength: 0
                  type: string
                filters:
                  description: List of filters.
                  items:
                    $ref: '#/components/schemas/scopes.v1.Filter'
                  minItems: 0
                  type: array
              required:
              - displayName
              - filters
              title: Create Scope Request
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScopeResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Create Scope
      tags:
      - Scopes Service
  /aaa/team-scopes/v1/all/list:
    get:
      description: Returns all data access scopes for the team.
      operationId: ScopesService_GetTeamScopes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScopesResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Get Team Scopes
      tags:
      - Scopes Service
  /aaa/team-scopes/v1/{id}:
    delete:
      description: Deletes the data access scope with the specified ID.
      operationId: ScopesService_DeleteScope
      parameters:
      - description: Unique identifier.
        in: path
        name: id
        required: true
        schema:
          description: Unique identifier.
          examples:
          - 60c82be2-413f-4b8e-8201-7f5c51e2ef2b
          minLength: 0
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteScopeResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      summary: Delete Scope
      tags:
      - Scopes Service
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          maximum: 599
          minimum: 100
          type: integer
          description: HTTP status code of the error (for example 400, 404, 500).
          format: int32
        message:
          maxLength: 4096
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description of the error.
      description: Standard error response body returned for a failed request.
    GetScopesResponse:
      title: Get Scopes Response
      required:
      - scopes
      type: object
      properties:
        scopes:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/v1.Scope'
          description: List of scopes.
      externalDocs:
        description: Find out more about scopes
        url: https://coralogix.com/docs/user-guides/account-management/user-management/scopes/
    CreateScopeResponse:
      title: Create Scope Response
      required:
      - scope
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/v1.Scope'
      externalDocs:
        description: Find out more about scopes
        url: https://coralogix.com/docs/user-guides/account-management/user-management/scopes/
    v1.EntityType:
      enum:
      - ENTITY_TYPE_UNSPECIFIED
      - ENTITY_TYPE_LOGS
      - ENTITY_TYPE_SPANS
      type: string
      description: Entity type.
    v1.Scope:
      title: Scope
      type: object
      properties:
        defaultExpression:
          minLength: 0
          type: string
          description: The default expression.
          examples:
          - <v1>true
        description:
          description: Human-readable description.
          examples:
          - The best scope
          minLength: 0
          type: string
          x-coralogix-presence: true
        displayName:
          minLength: 0
          type: string
          description: The display name.
          examples:
          - my-scope
        filters:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/scopes.v1.Filter'
          description: List of filters.
        id:
          minLength: 0
          type: string
          description: Unique identifier.
          examples:
          - 60c82be2-413f-4b8e-8201-7f5c51e2ef2b
        teamId:
          type: integer
          description: Team identifier.
          format: int32
          examples:
          - 1234
      externalDocs:
        description: Find out more about scopes
        url: https://coralogix.com/docs/user-guides/account-management/user-management/scopes/
    DeleteScopeResponse:
      type: object
      additionalProperties: false
      description: Response returned after successfully deleting a data access scope.
    scopes.v1.Filter:
      title: Filter
      type: object
      properties:
        entityType:
          $ref: '#/components/schemas/v1.EntityType'
        expression:
          minLength: 0
          type: string
          description: The expression.
          examples:
          - <v1>true
      externalDocs:
        description: Find out more about scopes
        url: https://coralogix.com/docs/user-guides/account-management/user-management/scopes/
    UpdateScopeResponse:
      title: Update Scope Response
      required:
      - scope
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/v1.Scope'
      externalDocs:
        description: Find out more about scopes
        url: https://coralogix.com/docs/user-guides/account-management/user-management/scopes/
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication
externalDocs:
  description: Coralogix API reference
  url: https://coralogix.com/docs/api-reference/v5/
x-provenance:
  method: harvested
  publisher: Coralogix
  source: https://coralogix.com/docs/openapi.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)