Moogsoft Apikeys Users API

Endpoints relating to API key operations

Operations 4

POST /v2/users/{userId}/keys Create a new API key #
GET /v2/users/{userId}/keys Get an API keys for an user #
GET /v2/users/{userId}/keys/{keyId} Get details for specific API key #
DELETE /v2/users/{userId}/keys/{keyId} Delete an API key associated with a user #

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

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-apikeys-users-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

moogsoft-apikeys-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  title: Apikeys Users 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: Apikeys-users
  description: Endpoints relating to API key operations
paths:
  /v2/users/{userId}/keys:
    post:
      tags:
      - Apikeys-users
      summary: Create a new API key
      description: Creates a new api key with the current user permissions
      operationId: createApiKey
      parameters:
      - name: userId
        in: path
        description: ID of the user the API key is associated with
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseApiKeyDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsgListResponseobject'
                __errors__:
                  '#/components/schemas/IsgListResponseobject': No foreign doc with id components found
        '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
    get:
      tags:
      - Apikeys-users
      summary: Get an API keys for an user
      description: Lists all the API keys associated with the system
      operationId: getUserApiKeys
      parameters:
      - name: userId
        in: path
        description: ID of the user the API keys belongs to
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfApiKeyDto'
        '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
  /v2/users/{userId}/keys/{keyId}:
    get:
      tags:
      - Apikeys-users
      summary: Get details for specific API key
      description: Returns the details for a specific API key
      operationId: getApiKey
      parameters:
      - name: keyId
        in: path
        description: ID of the API key to get details
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of the user the API key belongs to
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseApiKeyDto'
        '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
    delete:
      tags:
      - Apikeys-users
      summary: Delete an API key associated with a user
      description: Deletes the API associated with the userId
      operationId: deleteApiKey
      parameters:
      - name: keyId
        in: path
        description: ID of the API key to delete
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: ID of the user the API key belongs to
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IsgListResponseobject'
                __errors__:
                  '#/components/schemas/IsgListResponseobject': No foreign doc with id components found
        '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:
    BaseApiKeyDto:
      type: object
      title: Base Api Key Dto
      properties:
        name:
          type: string
          pattern: \S
          minLength: 1
          maxLength: 127
        description:
          type: string
        permissions:
          type: array
          items:
            type: string
      required:
      - name
    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
    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
    MoogResponseListOfApiKeyDto:
      type: object
      description: User API ApiKeyDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/ApiKeyDto'
      required:
      - status
      - data
    MoogResponseApiKeyDto:
      type: object
      description: User API ApiKeyDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          $ref: '#/components/schemas/ApiKeyDto'
      required:
      - status
      - data
    Date:
      type: number
      title: Date
      format: int64
      examples:
      - '2022-03-10'
    ApiKeyDto:
      type: object
      title: Api Key Dto
      properties:
        name:
          type: string
          pattern: \S
          minLength: 1
          maxLength: 127
        description:
          type: string
        permissions:
          type: array
          items:
            type: string
        id:
          type: string
        createdAt:
          $ref: '#/components/schemas/Date'
        userId:
          type: string
        userEmail:
          type: string
        apiKey:
          type: string
      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