Coralogix Global routers service API

openapi: 3.2.0
info:
  title: Coralogix Management Global routers 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: Global routers service
  description: View and manage your global routers - entities that direct notifications to configured destinations based on conditions
  externalDocs:
    description: Lean more about global routers in our documentation
    url: https://coralogix.com/docs/user-guides/notification-center/routing/introduction/
paths:
  /notifications/notification-center/v1/routers:
    get:
      description: Returns all notification routers for the team.
      operationId: GlobalRoutersService_ListGlobalRouters
      parameters:
      - description: Deprecated. Filter routers by entity type.
        in: query
        name: entity_type
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/notification_center.EntityType'
          deprecated: true
          description: Deprecated. Filter routers by entity type.
          x-coralogix-presence: true
      - description: Filter routers by source entity labels. Each entry restricts results to routers whose source entity has the matching label values. If empty, all routers are returned.
        in: query
        name: source_entity_labels
        required: false
        schema:
          additionalProperties:
            properties:
              values:
                description: The values.
                items:
                  description: The values.
                  minLength: 0
                  type: string
                maxItems: 100
                minItems: 1
                type: array
            type: object
          description: Filter routers by source entity labels. Each entry restricts results to routers whose source entity has the matching label values. If empty, all routers are returned.
          type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGlobalRoutersResponse'
          description: ''
      summary: List Global Routers
      tags:
      - Global routers service
    put:
      description: Updates an existing notification router.
      operationId: GlobalRoutersService_ReplaceGlobalRouter
      requestBody:
        content:
          application/json:
            schema:
              description: Request which updates an existing global router
              properties:
                router:
                  $ref: '#/components/schemas/GlobalRouter'
              required:
              - router
              title: Replace Global Router Request
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplaceGlobalRouterResponse'
          description: ''
      summary: Replace Global Router
      tags:
      - Global routers service
    post:
      description: Creates a new notification router.
      operationId: GlobalRoutersService_CreateGlobalRouter
      requestBody:
        content:
          application/json:
            schema:
              description: Request to create a global router
              properties:
                router:
                  $ref: '#/components/schemas/GlobalRouter'
              required:
              - router
              title: Create Global Router Request
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGlobalRouterResponse'
          description: ''
      summary: Create Global Router
      tags:
      - Global routers service
  /notifications/notification-center/v1/routers/all/summaries:
    get:
      description: Returns summary information for all notification routers.
      operationId: GlobalRoutersService_BatchGetGlobalRouters
      parameters:
      - description: The unique identifiers of the global routers to retrieve summaries for.
        in: query
        name: global_router_ids
        required: false
        schema:
          description: The unique identifiers of the global routers to retrieve summaries for.
          items:
            description: The unique identifiers of the global routers to retrieve summaries for.
            minLength: 0
            type: string
          maxItems: 200
          minItems: 0
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGetGlobalRoutersResponse'
          description: ''
      summary: Batch Get Global Routers
      tags:
      - Global routers service
  /notifications/notification-center/v1/routers/matcher/validate:
    post:
      description: Validates a notification router matcher configuration.
      operationId: GlobalRoutersService_ValidateEntityLabelMatcher
      parameters:
      - description: Entity label matcher to validate, expressed as a map of label keys to expected values.
        in: query
        name: entity_label_matcher
        required: false
        schema:
          additionalProperties:
            minLength: 0
            type: string
          description: Entity label matcher to validate, expressed as a map of label keys to expected values.
          type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateEntityLabelMatcherResponse'
          description: ''
      summary: Validate Entity Label Matcher
      tags:
      - Global routers service
  /notifications/notification-center/v1/routers/{id}:
    get:
      description: Returns the details of the specified notification router.
      operationId: GlobalRoutersService_GetGlobalRouter
      parameters:
      - description: The unique identifier of the global router to retrieve.
        in: path
        name: id
        required: true
        schema:
          description: The unique identifier of the global router to retrieve.
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGlobalRouterResponse'
          description: ''
      summary: Get Global Router
      tags:
      - Global routers service
    delete:
      description: Deletes the notification router with the specified ID.
      operationId: GlobalRoutersService_DeleteGlobalRouter
      parameters:
      - $ref: '#/components/parameters/id_4'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteGlobalRouterResponse'
          description: ''
      summary: Delete Global Router
      tags:
      - Global routers service
components:
  schemas:
    RoutingTarget:
      title: Routing Target
      required:
      - connectorId
      type: object
      properties:
        connectorId:
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          description: The connector id.
        customDetails:
          type: object
          additionalProperties:
            minLength: 0
            type: string
          description: The custom details.
        id:
          description: Unique identifier. Set by the server, which assigns a new value on every create and replace; a value sent by the client is ignored.
          examples:
          - d4b56246-64bb-4714-a8bd-97c999f1d801
          maxLength: 36
          minLength: 36
          pattern: ^[\s\S]*$
          readOnly: true
          type: string
          x-coralogix-presence: true
        presetId:
          description: The preset id.
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          x-coralogix-presence: true
      description: Defines routing target for notifications
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    ValidateEntityLabelMatcherResult:
      type: object
      oneOf:
      - required:
        - success
        type: object
      - required:
        - failure
        type: object
      - type: object
        not:
          anyOf:
          - required:
            - success
            type: object
          - required:
            - failure
            type: object
      properties:
        failure:
          $ref: '#/components/schemas/ValidateEntityLabelMatcherResult.Failure'
        success:
          $ref: '#/components/schemas/ValidateEntityLabelMatcherResult.Success'
      description: Result of validating an entity label matcher, indicating whether it is valid or contains errors.
    ValidateEntityLabelMatcherResult.Failure:
      type: object
      properties:
        message:
          maxLength: 10000
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable message.
      description: Test outgoing webhook response.failure.
    BatchGetGlobalRoutersResponse:
      title: Batch Get Global Routers Response
      type: object
      properties:
        notFoundIds:
          maxItems: 200
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            description: The not found ids.
          description: The not found ids.
          examples:
          - - global-router-id-3
        routers:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/GlobalRouter'
          description: The routers.
      description: Response containing requested global routers and missing global routers ids
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    ValidateEntityLabelMatcherResult.Success:
      type: object
      additionalProperties: false
      description: Test integration result.success.
    DeleteGlobalRouterResponse:
      type: object
      additionalProperties: false
      description: Response returned after successfully deleting a notification router.
    FallbackTarget:
      title: FallbackTarget
      required:
      - entityType
      - target
      type: object
      properties:
        entityType:
          $ref: '#/components/schemas/notification_center.EntityType'
        target:
          $ref: '#/components/schemas/RoutingTarget'
      description: Defines fallback target for notifications not matching any routing rule
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    RoutingLabels:
      title: Routing Labels
      type: object
      properties:
        environment:
          description: The environment. The limit is 255 bytes.
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          x-coralogix-presence: true
        service:
          description: Service name. The limit is 255 bytes.
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          x-coralogix-presence: true
        team:
          description: Team. The limit is 255 bytes.
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          x-coralogix-presence: true
      description: Allows to configure routing labels which are used for routers resolution. Every router needs at least one label, except the default router, whose `id` is `router_default`. The default router must have no labels.
      externalDocs:
        description: Find out more how label based routers work
        url: https://coralogix.com/docs/user-guides/notification-center/routing/introduction/#how-label-based-routers-work
    notification_center.EntityType:
      enum:
      - ENTITY_TYPE_UNSPECIFIED
      - ALERTS
      - TEST_NOTIFICATIONS
      - CASES
      - OLLY_SCHEDULED_TASKS
      type: string
      description: Entity type.
    ListGlobalRoutersResponse:
      title: List Global Routers Response
      type: object
      properties:
        routers:
          maxItems: 200
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/GlobalRouter'
          description: The routers.
      description: Response containing requested global routers
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    ValidateEntityLabelMatcherResponse:
      title: Validate Entity Label Matcher Response
      type: object
      properties:
        result:
          $ref: '#/components/schemas/ValidateEntityLabelMatcherResult'
      description: Response which contains whether the given entity label matcher is valid
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    ReplaceGlobalRouterResponse:
      title: Replace Global Router Response
      type: object
      properties:
        router:
          $ref: '#/components/schemas/GlobalRouter'
      description: Response which contains an updated global router
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    CreateGlobalRouterResponse:
      title: Create Global Router Response
      type: object
      properties:
        router:
          $ref: '#/components/schemas/GlobalRouter'
      description: Response which contains a created global router
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    RoutingRule:
      title: Routing Rule
      required:
      - condition
      - name
      type: object
      properties:
        condition:
          maxLength: 20000
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Condition.
          examples:
          - alertDef.priority == 'P3'
        customDetails:
          type: object
          additionalProperties:
            minLength: 0
            type: string
          description: The custom details.
        entityType:
          allOf:
          - $ref: '#/components/schemas/notification_center.EntityType'
          default: ALERTS
          examples:
          - ALERTS
          x-coralogix-presence: true
        name:
          description: Display name.
          maxLength: 200
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          x-coralogix-presence: true
        targets:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/RoutingTarget'
          description: List of targets. The server does not keep the order of the targets.
      description: Defines routing rule for notifications
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    GlobalRouter:
      title: Global Router
      required:
      - name
      type: object
      properties:
        createTime:
          description: The create time. Set by the server; a value sent by the client is ignored.
          format: date-time
          minLength: 0
          readOnly: true
          type: string
          x-coralogix-presence: true
        description:
          maxLength: 5000
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description.
        disabled:
          default: false
          description: Whether the router is disabled.
          type: boolean
          x-coralogix-presence: true
        entityLabels:
          type: object
          additionalProperties:
            minLength: 0
            type: string
          description: The entity labels.
        entityType:
          allOf:
          - $ref: '#/components/schemas/notification_center.EntityType'
          deprecated: true
          x-coralogix-presence: true
        fallback:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/RoutingTarget'
          description: 'The fallback destinations to be used if no rule matches. Deprecated: use fallbackTargets. A router cannot set both fallback and fallbackTargets. The server does not keep the order of the targets.'
          deprecated: true
        fallbackTargets:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/FallbackTarget'
          description: The fallback targets. A router cannot set both fallback and fallbackTargets. The server does not keep the order of the fallback targets.
        id:
          description: Unique identifier.
          examples:
          - a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
          type: string
          x-coralogix-presence: true
        name:
          maxLength: 200
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Display name.
          examples:
          - My Router
        routingLabels:
          $ref: '#/components/schemas/RoutingLabels'
        rules:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/RoutingRule'
          description: List of rules.
        updateTime:
          description: Timestamp of the last update. Set by the server; a value sent by the client is ignored.
          format: date-time
          minLength: 0
          readOnly: true
          type: string
          x-coralogix-presence: true
      description: Defines a set of pre-configured routing rules for directing notifications
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
    GetGlobalRouterResponse:
      title: Get Global Router Response
      type: object
      properties:
        router:
          $ref: '#/components/schemas/GlobalRouter'
      description: Response containing a requested global router
      externalDocs:
        description: Find out more about notification center
        url: https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/
  parameters:
    id_4:
      name: id
      in: path
      description: Unique identifier.
      required: true
      schema:
        maxLength: 128
        minLength: 1
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
        type: string
        description: Unique identifier.
  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)