Microsoft Azure Service Health: API

The Service Health: API from Microsoft Azure — 1 operation(s) for service health:.

Documentation GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /healthstatus Check the service's overall health · Microsoft Azure Returns The Overall Health Of The Service And Optionally Of The… #

Ask an LLM

“Is the speech service healthy right now?”

“Can I see the health of each subcomponent of the service?”

Tell an agent

Get the service health status.

Show overall and subcomponent health for the service.

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/microsoft-azure:microsoft-azure-service-health-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

openapi: 3.2.0
info:
  title: 'Microsoft Azure Service Health: API'
  version: '1.0'
  description: 'Operations tagged Service Health: across 2 of this provider''s published API definitions: speech-services-api-v30-openapi-original.yml, speech-services-api-v32-preview2-openapi-original.yml. Each path carries the servers of the definition it was published in.'
security:
- api_key: []
- token: []
tags:
- name: 'Service Health:'
paths:
  /healthstatus:
    get:
      tags:
      - 'Service Health:'
      summary: Microsoft Azure Returns The Overall Health Of The Service And Optionally Of The…
      operationId: microsoftAzureGethealthstatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHealth'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        Gets the health status:
          $ref: examples/get_healthstatus.json
      description: Needs a more full description created.
components:
  schemas:
    Component:
      title: Component
      type: object
      properties:
        message:
          description: Additional messages about the current service health.
          type: string
          readOnly: true
        name:
          description: The name of the component.
          type: string
          readOnly: true
        status:
          $ref: '#/components/schemas/HealthStatus'
        type:
          description: The type of this component.
          type: string
          readOnly: true
    Error:
      title: Error
      description: 'New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.

        This contains an outer error with error code, message, details, target and an inner error with more descriptive details.'
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        details:
          description: Additional supportive details regarding the error and/or expected policies.
          type: array
          items:
            $ref: '#/components/schemas/Error'
        message:
          description: High level error message.
          type: string
        target:
          description: 'The source of the error.

            For example it would be "documents" or "document id" in case of invalid document.'
          type: string
        innerError:
          $ref: '#/components/schemas/InnerError'
    ServiceHealth:
      title: ServiceHealth
      type: object
      properties:
        status:
          $ref: '#/components/schemas/HealthStatus'
        message:
          description: Additional messages about the current service health.
          type: string
          readOnly: true
        components:
          description: Optional subcomponents of this service and their status.
          type: array
          items:
            $ref: '#/components/schemas/Component'
          readOnly: true
    ErrorCode:
      title: ErrorCode
      description: High level error codes.
      enum:
      - InvalidRequest
      - InvalidArgument
      - InternalServerError
      - ServiceUnavailable
      - NotFound
      - PipelineError
      - Conflict
      - InternalCommunicationFailed
      - Forbidden
      - NotAllowed
      - Unauthorized
      - UnsupportedMediaType
      - TooManyRequests
      - UnprocessableEntity
      type: string
      x-ms-enum:
        name: ErrorCode
        modelAsString: true
        values:
        - value: InvalidRequest
          description: Representing the invalid request error code.
        - value: InvalidArgument
          description: Representing the invalid argument error code.
        - value: InternalServerError
          description: Representing the internal server error error code.
        - value: ServiceUnavailable
          description: Representing the service unavailable error code.
        - value: NotFound
          description: Representing the not found error code.
        - value: PipelineError
          description: Representing the pipeline error error code.
        - value: Conflict
          description: Representing the conflict error code.
        - value: InternalCommunicationFailed
          description: Representing the internal communication failed error code.
        - value: Forbidden
          description: Representing the forbidden error code.
        - value: NotAllowed
          description: Representing the not allowed error code.
        - value: Unauthorized
          description: Representing the unauthorized error code.
        - value: UnsupportedMediaType
          description: Representing the unsupported media type error code.
        - value: TooManyRequests
          description: Representing the too many requests error code.
        - value: UnprocessableEntity
          description: Representing the unprocessable entity error code.
    InnerError:
      title: InnerError
      description: 'New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.

        This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).'
      type: object
      properties:
        code:
          $ref: '#/components/schemas/DetailedErrorCode'
        details:
          description: Additional supportive details regarding the error and/or expected policies.
          type: object
          additionalProperties:
            type: string
        message:
          description: High level error message.
          type: string
        target:
          description: 'The source of the error.

            For example it would be "documents" or "document id" in case of invalid document.'
          type: string
        innerError:
          $ref: '#/components/schemas/InnerError'
    HealthStatus:
      title: HealthStatus
      description: Health status of the service.
      enum:
      - Unhealthy
      - Degraded
      - Healthy
      type: string
      readOnly: true
      x-ms-enum:
        name: HealthStatus
        modelAsString: false
        values:
        - value: Unhealthy
          description: Unhealthy.
        - value: Degraded
          description: Degraded.
        - value: Healthy
          description: Healthy.
    DetailedErrorCode:
      title: DetailedErrorCode
      description: Detailed error code enum.
      enum:
      - InvalidParameterValue
      - InvalidRequestBodyFormat
      - EmptyRequest
      - MissingInputRecords
      - InvalidDocument
      - ModelVersionIncorrect
      - InvalidDocumentBatch
      - UnsupportedLanguageCode
      - DataImportFailed
      - InUseViolation
      - InvalidLocale
      - InvalidBaseModel
      - InvalidAdaptationMapping
      - InvalidDataset
      - InvalidTest
      - FailedDataset
      - InvalidModel
      - InvalidTranscription
      - InvalidPayload
      - InvalidParameter
      - EndpointWithoutLogging
      - InvalidPermissions
      - InvalidPrerequisite
      - InvalidProductId
      - InvalidSubscription
      - InvalidProject
      - InvalidProjectKind
      - InvalidRecordingsUri
      - OnlyOneOfUrlsOrContainerOrDataset
      - ExceededNumberOfRecordingsUris
      - ModelMismatch
      - ProjectGenderMismatch
      - ModelDeprecated
      - ModelExists
      - ModelNotDeployable
      - EndpointNotUpdatable
      - SingleDefaultEndpoint
      - EndpointCannotBeDefault
      - InvalidModelUri
      - SubscriptionNotFound
      - QuotaViolation
      - UnsupportedDelta
      - UnsupportedFilter
      - UnsupportedPagination
      - UnsupportedDynamicConfiguration
      - UnsupportedOrderBy
      - NoUtf8WithBom
      - ModelDeploymentNotCompleteState
      - SkuLimitsExist
      - DeployingFailedModel
      - UnsupportedTimeRange
      - InvalidLogDate
      - InvalidLogId
      - InvalidLogStartTime
      - InvalidLogEndTime
      - InvalidTopForLogs
      - InvalidSkipTokenForLogs
      - DeleteNotAllowed
      - Forbidden
      - DeployNotAllowed
      - UnexpectedError
      - InvalidCollection
      - InvalidCallbackUri
      - InvalidSasValidityDuration
      - InaccessibleCustomerStorage
      - UnsupportedClassBasedAdaptation
      - InvalidWebHookEventKind
      - InvalidTimeToLive
      type: string
      x-ms-enum:
        name: DetailedErrorCode
        modelAsString: true
        values:
        - value: InvalidParameterValue
          description: Invalid parameter value.
        - value: InvalidRequestBodyFormat
          description: Invalid request body format.
        - value: EmptyRequest
          description: Empty Request.
        - value: MissingInputRecords
          description: Missing Input Records.
        - value: InvalidDocument
          description: Invalid Document.
        - value: ModelVersionIncorrect
          description: Model Version Incorrect.
        - value: InvalidDocumentBatch
          description: Invalid Document Batch.
        - value: UnsupportedLanguageCode
          description: Unsupported language code.
        - value: DataImportFailed
          description: Data import failed.
        - value: InUseViolation
          description: In use violation.
        - value: InvalidLocale
          description: Invalid locale.
        - value: InvalidBaseModel
          description: Invalid base model.
        - value: InvalidAdaptationMapping
          description: Invalid adaptation mapping.
        - value: InvalidDataset
          description: Invalid dataset.
        - value: InvalidTest
          description: Invalid test.
        - value: FailedDataset
          description: Failed dataset.
        - value: InvalidModel
          description: Invalid model.
        - value: InvalidTranscription
          description: Invalid transcription.
        - value: InvalidPayload
          description: Invalid payload.
        - value: InvalidParameter
          description: Invalid parameter.
        - value: EndpointWithoutLogging
          description: Endpoint without logging.
        - value: InvalidPermissions
          description: Invalid permissions.
        - value: InvalidPrerequisite
          description: Invalid prerequisite.
        - value: InvalidProductId
          description: Invalid product id.
        - value: InvalidSubscription
          description: Invalid subscription.
        - value: InvalidProject
          description: Invalid project.
        - value: InvalidProjectKind
          description: Invalid project kind.
        - value: InvalidRecordingsUri
          description: Invalid recordings uri.
        - value: OnlyOneOfUrlsOrContainerOrDataset
          description: Only one of urls or container or dataset.
        - value: ExceededNumberOfRecordingsUris
          description: Exceeded number of recordings uris.
        - value: ModelMismatch
          description: Model mismatch.
        - value: ProjectGenderMismatch
          description: Project gender mismatch.
        - value: ModelDeprecated
          description: Model deprecated.
        - value: ModelExists
          description: Model exists.
        - value: ModelNotDeployable
          description: Model not deployable.
        - value: EndpointNotUpdatable
          description: Endpoint not updatable.
        - value: SingleDefaultEndpoint
          description: Single default endpoint.
        - value: EndpointCannotBeDefault
          description: Endpoint cannot be default.
        - value: InvalidModelUri
          description: Invalid model uri.
        - value: SubscriptionNotFound
          description: Subscription not found.
        - value: QuotaViolation
          description: Quota violation.
        - value: UnsupportedDelta
          description: Unsupported delta.
        - value: UnsupportedFilter
          description: Unsupported filter.
        - value: UnsupportedPagination
          description: Unsupported pagination.
        - value: UnsupportedDynamicConfiguration
          description: Unsupported dynamic configuration.
        - value: UnsupportedOrderBy
          description: Unsupported order by.
        - value: NoUtf8WithBom
          description: No utf8 with bom.
        - value: ModelDeploymentNotCompleteState
          description: Model deployment not complete state.
        - value: SkuLimitsExist
          description: Sku limits exist.
        - value: DeployingFailedModel
          description: Deploying failed model.
        - value: UnsupportedTimeRange
          description: Unsupported time range.
        - value: InvalidLogDate
          description: Invalid log date.
        - value: InvalidLogId
          description: Invalid log id.
        - value: InvalidLogStartTime
          description: Invalid log start time.
        - value: InvalidLogEndTime
          description: Invalid log end time.
        - value: InvalidTopForLogs
          description: Invalid top for logs.
        - value: InvalidSkipTokenForLogs
          description: Invalid skip token for logs.
        - value: DeleteNotAllowed
          description: Delete not allowed.
        - value: Forbidden
          description: Forbidden.
        - value: DeployNotAllowed
          description: Deploy not allowed.
        - value: UnexpectedError
          description: Unexpected error.
        - value: InvalidCollection
          description: Invalid collection.
        - value: InvalidCallbackUri
          description: Invalid callback uri.
        - value: InvalidSasValidityDuration
          description: Invalid sas validity duration.
        - value: InaccessibleCustomerStorage
          description: Inaccessible customer storage.
        - value: UnsupportedClassBasedAdaptation
          description: Unsupported class based adaptation.
        - value: InvalidWebHookEventKind
          description: Invalid web hook event kind.
        - value: InvalidTimeToLive
          description: Invalid time to live.
    DetailedErrorCode_2:
      title: DetailedErrorCode
      description: Detailed error code enum.
      enum:
      - InvalidParameterValue
      - InvalidRequestBodyFormat
      - EmptyRequest
      - MissingInputRecords
      - InvalidDocument
      - ModelVersionIncorrect
      - InvalidDocumentBatch
      - UnsupportedLanguageCode
      - DataImportFailed
      - InUseViolation
      - InvalidLocale
      - InvalidBaseModel
      - InvalidAdaptationMapping
      - InvalidDataset
      - InvalidTest
      - FailedDataset
      - InvalidModel
      - InvalidTranscription
      - InvalidPayload
      - InvalidParameter
      - EndpointWithoutLogging
      - InvalidPermissions
      - InvalidPrerequisite
      - InvalidProductId
      - InvalidSubscription
      - InvalidProject
      - InvalidProjectKind
      - InvalidRecordingsUri
      - OnlyOneOfUrlsOrContainerOrDataset
      - ExceededNumberOfRecordingsUris
      - ModelMismatch
      - ProjectGenderMismatch
      - ModelDeprecated
      - ModelExists
      - ModelNotDeployable
      - EndpointNotUpdatable
      - SingleDefaultEndpoint
      - EndpointCannotBeDefault
      - InvalidModelUri
      - SubscriptionNotFound
      - QuotaViolation
      - UnsupportedDelta
      - UnsupportedFilter
      - UnsupportedPagination
      - UnsupportedDynamicConfiguration
      - UnsupportedOrderBy
      - NoUtf8WithBom
      - ModelDeploymentNotCompleteState
      - SkuLimitsExist
      - DeployingFailedModel
      - UnsupportedTimeRange
      - InvalidLogDate
      - InvalidLogId
      - InvalidLogStartTime
      - InvalidLogEndTime
      - InvalidTopForLogs
      - InvalidSkipTokenForLogs
      - DeleteNotAllowed
      - Forbidden
      - DeployNotAllowed
      - UnexpectedError
      - InvalidCollection
      - InvalidCallbackUri
      - InvalidSasValidityDuration
      - InaccessibleCustomerStorage
      - UnsupportedClassBasedAdaptation
      - InvalidWebHookEventKind
      - InvalidTimeToLive
      - InvalidSourceAzureResourceId
      - ModelCopyOperationExists
      type: string
      x-ms-enum:
        name: DetailedErrorCode
        modelAsString: true
        values:
        - value: InvalidParameterValue
          description: Invalid parameter value.
        - value: InvalidRequestBodyFormat
          description: Invalid request body format.
        - value: EmptyRequest
          description: Empty Request.
        - value: MissingInputRecords
          description: Missing Input Records.
        - value: InvalidDocument
          description: Invalid Document.
        - value: ModelVersionIncorrect
          description: Model Version Incorrect.
        - value: InvalidDocumentBatch
          description: Invalid Document Batch.
        - value: UnsupportedLanguageCode
          description: Unsupported language code.
        - value: DataImportFailed
          description: Data import failed.
        - value: InUseViolation
          description: In use violation.
        - value: InvalidLocale
          description: Invalid locale.
        - value: InvalidBaseModel
          description: Invalid base model.
        - value: InvalidAdaptationMapping
          description: Invalid adaptation mapping.
        - value: InvalidDataset
          description: Invalid dataset.
        - value: InvalidTest
          description: Invalid test.
        - value: FailedDataset
          description: Failed dataset.
        - value: InvalidModel
          description: Invalid model.
        - value: InvalidTranscription
          description: Invalid transcription.
        - value: InvalidPayload
          description: Invalid payload.
        - value: InvalidParameter
          description: Invalid parameter.
        - value: EndpointWithoutLogging
          description: Endpoint without logging.
        - value: InvalidPermissions
          description: Invalid permissions.
        - value: InvalidPrerequisite
          description: Invalid prerequisite.
        - value: InvalidProductId
          description: Invalid product id.
        - value: InvalidSubscription
          description: Invalid subscription.
        - value: InvalidProject
          description: Invalid project.
        - value: InvalidProjectKind
          description: Invalid project kind.
        - value: InvalidRecordingsUri
          description: Invalid recordings uri.
        - value: OnlyOneOfUrlsOrContainerOrDataset
          description: Only one of urls or container or dataset.
        - value: ExceededNumberOfRecordingsUris
          description: Exceeded number of recordings uris.
        - value: ModelMismatch
          description: Model mismatch.
        - value: ProjectGenderMismatch
          description: Project gender mismatch.
        - value: ModelDeprecated
          description: Model deprecated.
        - value: ModelExists
          description: Model exists.
        - value: ModelNotDeployable
          description: Model not deployable.
        - value: EndpointNotUpdatable
          description: Endpoint not updatable.
        - value: SingleDefaultEndpoint
          description: Single default endpoint.
        - value: EndpointCannotBeDefault
          description: Endpoint cannot be default.
        - value: InvalidModelUri
          description: Invalid model uri.
        - value: SubscriptionNotFound
          description: Subscription not found.
        - value: QuotaViolation
          description: Quota violation.
        - value: UnsupportedDelta
          description: Unsupported delta.
        - value: UnsupportedFilter
          description: Unsupported filter.
        - value: UnsupportedPagination
          description: Unsupported pagination.
        - value: UnsupportedDynamicConfiguration
          description: Unsupported dynamic configuration.
        - value: UnsupportedOrderBy
          description: Unsupported order by.
        - value: NoUtf8WithBom
          description: No utf8 with bom.
        - value: ModelDeploymentNotCompleteState
          description: Model deployment not complete state.
        - value: SkuLimitsExist
          description: Sku limits exist.
        - value: DeployingFailedModel
          description: Deploying failed model.
        - value: UnsupportedTimeRange
          description: Unsupported time range.
        - value: InvalidLogDate
          description: Invalid log date.
        - value: InvalidLogId
          description: Invalid log id.
        - value: InvalidLogStartTime
          description: Invalid log start time.
        - value: InvalidLogEndTime
          description: Invalid log end time.
        - value: InvalidTopForLogs
          description: Invalid top for logs.
        - value: InvalidSkipTokenForLogs
          description: Invalid skip token for logs.
        - value: DeleteNotAllowed
          description: Delete not allowed.
        - value: Forbidden
          description: Forbidden.
        - value: DeployNotAllowed
          description: Deploy not allowed.
        - value: UnexpectedError
          description: Unexpected error.
        - value: InvalidCollection
          description: Invalid collection.
        - value: InvalidCallbackUri
          description: Invalid callback uri.
        - value: InvalidSasValidityDuration
          description: Invalid sas validity duration.
        - value: InaccessibleCustomerStorage
          description: Inaccessible customer storage.
        - value: UnsupportedClassBasedAdaptation
          description: Unsupported class based adaptation.
        - value: InvalidWebHookEventKind
          description: Invalid web hook event kind.
        - value: InvalidTimeToLive
          description: Invalid time to live.
        - value: InvalidSourceAzureResourceId
          description: Invalid source Azure resource ID.
        - value: ModelCopyOperationExists
          description: Model copy operation exists.
  securitySchemes:
    api_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: Provide your cognitive services account key here.
    token:
      type: apiKey
      name: Authorization
      in: header
      description: 'Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement'
x-refined-from:
- speech-services-api-v30-openapi-original.yml
- speech-services-api-v32-preview2-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'