Moogsoft

Moogsoft Roles API

Endpoints relating to user roles

GitHub OpenAPI

Operations 5

GET /v1/roles Get all roles in the system #
POST /v1/roles Create a new roles in the system #
PATCH /v1/roles/{id} Update a role in the system #
GET /v1/roles/{id} Get specific role details #
DELETE /v1/roles/{id} Delete a custom role in the system #

Documentation

📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/4c987d4e03d42-alerts-incidents-api
📖
Documentation
https://docs.moogsoft.com/moogsoft-cloud/en/apis.html
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/07cc903e08dc7-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/98cab8f6ded6e-create-your-own-integration-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/b97257c4537e0-apex-ai-ops-incident-management-cloudwatch-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/16cc8392c9c10-collector-v2-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/a2faf5e9de2e7-config-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/872078c341608-events-integration
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/97383d5459cfb-on-call-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/7d9c8544a63bc-service-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/0f37a18e12cae-metrics-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/6295a1a5fa988-pager-duty-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/1328bccd943e6-probable-root-cause-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/8a70ecaa6cb8f-similar-incidents-service-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/02e00ab7d09f7-ui-services-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/af91225840fe8-user-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/22b7ec881443b-webhook-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/433fa2324eebd-workflow-engine-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-roles-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/moogsoft-roles-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

moogsoft-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: User Roles API
  description: API for User Service
  termsOfService: https://www.moogsoft.com/legal-information/express-terms-conditions/
  contact:
    name: API Support
    url: https://docs.moogsoft.com/en/moogsoft-apis.html
    email: support@moogsoft.com
  license:
    url: https://www.moogsoft.com/legal-information
    name: Apex AIOps Incident Management Proprietary
servers:
- url: https://api.moogsoft.ai
- url: https://api.dev.moogsoft.cloud
security:
- ApiKeyAuth: []
tags:
- name: Roles
  description: Endpoints relating to user roles
paths:
  /v1/roles:
    get:
      tags:
      - Roles
      summary: Get all roles in the system
      description: Get all roles currently defined in the system
      operationId: getRoles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfRoleDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        value:
        - user:no-access
        description: Required user permissions for this endpoint
    post:
      tags:
      - Roles
      summary: Create a new roles in the system
      description: Create a new role in the system
      operationId: postRoles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseRoleDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseRoleDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        value:
        - user:edit
        description: Required user permissions for this endpoint
  /v1/roles/{id}:
    patch:
      tags:
      - Roles
      summary: Update a role in the system
      description: Update an existing role in the system
      operationId: patchRoles
      parameters:
      - name: id
        in: path
        description: ID of the role
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseRoleDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseRoleDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        value:
        - user:edit
        description: Required user permissions for this endpoint
    get:
      tags:
      - Roles
      summary: Get specific role details
      description: Get details for a specific role
      operationId: getRole
      parameters:
      - name: id
        in: path
        description: ID of the role
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseRoleDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        value:
        - user:view
        description: Required user permissions for this endpoint
    delete:
      tags:
      - Roles
      summary: Delete a custom role in the system
      description: Delete a role already in the system.
      operationId: deleteRole
      parameters:
      - name: id
        in: path
        description: ID of the role
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        value:
        - user:edit
        description: Required user permissions for this endpoint
components:
  schemas:
    Instant:
      type: number
      title: Instant
      format: int64
      examples:
      - '2022-03-10T16:15:50Z'
    MoogErrorResponse:
      type: object
      description: User API error response body
      properties:
        status:
          type: string
          description: Error status indicator (always "error")
          examples:
          - error
        message:
          type: string
        additional:
          type: array
          items:
            type: string
      required:
      - status
      - message
    MoogResponseListOfRoleDto:
      type: object
      description: User API RoleDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/RoleDto'
      required:
      - status
      - data
    MoogFailureResponse:
      type: object
      description: User API failure response body
      properties:
        status:
          type: string
          description: Failure status indicator (always "failure")
          examples:
          - failure
        message:
          type: string
        additional:
          type: array
          items:
            type: string
      required:
      - status
      - message
    RoleDto:
      type: object
      title: Role Dto
      properties:
        name:
          type: string
          pattern: ^[a-zA-Z0-9.&()_\-\s]+$
          minLength: 1
          maxLength: 127
        description:
          type: string
        permissionsAsString:
          type: array
          items:
            type: string
            minLength: 1
        id:
          type: string
        created:
          $ref: '#/components/schemas/Instant'
        createdBy:
          type: string
        lastModified:
          $ref: '#/components/schemas/Instant'
        lastModifiedBy:
          type: string
      required:
      - name
    MoogResponseRoleDto:
      type: object
      description: User API RoleDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          $ref: '#/components/schemas/RoleDto'
      required:
      - status
      - data
    BaseRoleDto:
      type: object
      title: Base Role Dto
      properties:
        name:
          type: string
          pattern: ^[a-zA-Z0-9.&()_\-\s]+$
          minLength: 1
          maxLength: 127
        description:
          type: string
        permissionsAsString:
          type: array
          items:
            type: string
            minLength: 1
      required:
      - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API Key for accessing User API
      name: apiKey
      in: header
externalDocs:
  url: https://docs.moogsoft.com/en/moogsoft-apis.html
  description: Find out more about Apex AIOps Incident Management