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-queue-storage:microsoft-azure-queue-storage-messages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: 3.2.0
info:
title: Azure Queue Storage Messages API
version: '2026-04-06'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
- https://storage.azure.com/.default
tags:
- name: Messages
paths:
/messages:
get:
operationId: Queue_ReceiveMessages
description: Retrieves one or more messages from the front of the queue.
parameters:
- name: x-ms-version
in: header
description: Specifies the version of the operation to use for this request.
required: true
x-ms-client-name: version
schema:
type: string
- name: x-ms-client-request-id
in: header
description: An opaque, globally-unique, client-generated string identifier for the request.
required: false
x-ms-client-name: clientRequestId
schema:
type: string
format: uuid
- name: numofmessages
in: query
description: 'A nonzero integer value that specifies the number of messages to
retrieve from the queue, up to a maximum of 32. If fewer are visible, the
visible messages are returned. By default, a single message is retrieved from
the queue with this operation.'
required: false
x-ms-client-name: numberOfMessages
schema:
type: integer
format: int32
minimum: 1
- name: visibilitytimeout
in: query
description: 'Specifies the new visibility timeout value, in seconds, relative to server time. A specified value must be
larger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message
can be set to a value later than the expiry time.'
required: false
x-ms-client-name: visibilityTimeout
schema:
type: integer
format: int32
maximum: 604800
- name: timeout
in: query
description: 'The timeout parameter is expressed in seconds. For more information, see
<a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a>'
required: false
schema:
type: integer
format: int32
minimum: 0
responses:
'200':
description: The request has succeeded.
headers:
Date:
description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
schema:
type: string
format: date-time-rfc7231
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-request-id:
description: An opaque, globally-unique, server-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-version:
description: Specifies the version of the operation to use for this request.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/ReceivedMessages'
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: The error code.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/Error'
tags:
- Messages
summary: Queue receive messages
x-summary-source: derived
post:
operationId: Queue_SendMessage
description: 'Adds a new message to the back of the message queue. A visibility timeout
can also be specified to make the message invisible until the visibility timeout
expires.'
parameters:
- name: x-ms-version
in: header
description: Specifies the version of the operation to use for this request.
required: true
x-ms-client-name: version
schema:
type: string
- name: x-ms-client-request-id
in: header
description: An opaque, globally-unique, client-generated string identifier for the request.
required: false
x-ms-client-name: clientRequestId
schema:
type: string
format: uuid
- name: visibilitytimeout
in: query
description: 'Specifies the new visibility timeout value, in seconds, relative to server time. A specified value must be
larger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message
can be set to a value later than the expiry time.'
required: false
x-ms-client-name: visibilityTimeout
schema:
type: integer
format: int32
maximum: 604800
- name: messagettl
in: query
description: 'Specifies the time-to-live interval for the message, in seconds.
Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For
version 2017-07-29 or later, the maximum time-to-live can be any positive
number, as well as -1 indicating that the message does not expire. If this
parameter is omitted, the default time-to-live is 7 days.'
required: false
x-ms-client-name: messageTimeToLive
schema:
type: integer
format: int32
minimum: -1
- name: timeout
in: query
description: 'The timeout parameter is expressed in seconds. For more information, see
<a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a>'
required: false
schema:
type: integer
format: int32
minimum: 0
responses:
'201':
description: The request has succeeded and a new resource has been created as a result.
headers:
Date:
description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
schema:
type: string
format: date-time-rfc7231
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-request-id:
description: An opaque, globally-unique, server-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-version:
description: Specifies the version of the operation to use for this request.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/ListOfSentMessage'
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: The error code.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/QueueMessage'
description: 'The queue message. The message must be in a format that can be included in an XML request with UTF-8
encoding. The encoded message can be up to 64 KB in size.'
required: true
tags:
- Messages
summary: Queue send message
x-summary-source: derived
delete:
operationId: Queue_Clear
description: Deletes all messages from the specified queue.
parameters:
- name: x-ms-version
in: header
description: Specifies the version of the operation to use for this request.
required: true
x-ms-client-name: version
schema:
type: string
- name: x-ms-client-request-id
in: header
description: An opaque, globally-unique, client-generated string identifier for the request.
required: false
x-ms-client-name: clientRequestId
schema:
type: string
format: uuid
- name: timeout
in: query
description: 'The timeout parameter is expressed in seconds. For more information, see
<a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a>'
required: false
schema:
type: integer
format: int32
minimum: 0
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
headers:
Date:
description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
schema:
type: string
format: date-time-rfc7231
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-request-id:
description: An opaque, globally-unique, server-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-version:
description: Specifies the version of the operation to use for this request.
schema:
type: string
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: The error code.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/Error'
tags:
- Messages
summary: Queue clear
x-summary-source: derived
/messages/{messageId}:
put:
operationId: Queue_UpdateMessage
description: Updates the visibility timeout of a message. This operation can also be used to update the contents of a message.
parameters:
- name: x-ms-version
in: header
description: Specifies the version of the operation to use for this request.
required: true
x-ms-client-name: version
schema:
type: string
- name: x-ms-client-request-id
in: header
description: An opaque, globally-unique, client-generated string identifier for the request.
required: false
x-ms-client-name: clientRequestId
schema:
type: string
format: uuid
- name: messageId
in: path
description: The ID of the queue message.
required: true
schema:
type: string
- name: popreceipt
in: query
description: 'An opaque value required to delete the message. If deletion fails using this
PopReceipt then the message has been dequeued by another client.'
required: true
x-ms-client-name: popReceipt
schema:
type: string
- name: visibilitytimeout
in: query
description: 'Specifies the new visibility timeout value, in seconds, relative to server time. A specified value must be
larger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message
can be set to a value later than the expiry time.'
required: true
x-ms-client-name: visibilityTimeout
schema:
type: integer
format: int32
maximum: 604800
- name: timeout
in: query
description: 'The timeout parameter is expressed in seconds. For more information, see
<a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a>'
required: false
schema:
type: integer
format: int32
minimum: 0
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
headers:
Date:
description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
schema:
type: string
format: date-time-rfc7231
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-popreceipt:
description: The pop receipt of the queue message.
schema:
type: string
x-ms-request-id:
description: An opaque, globally-unique, server-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-time-next-visible:
description: A UTC date/time value that represents when the message will be visible on the queue.
schema:
type: string
format: date-time-rfc7231
x-ms-version:
description: Specifies the version of the operation to use for this request.
schema:
type: string
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: The error code.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/QueueMessage'
description: 'The queue message. The message must be in a format that can be included in
an XML request with UTF-8 encoding. The encoded message can be up to 64 KB in size.'
tags:
- Messages
summary: Queue update message
x-summary-source: derived
delete:
operationId: Queue_DeleteMessage
description: Deletes the specified message.
parameters:
- name: x-ms-version
in: header
description: Specifies the version of the operation to use for this request.
required: true
x-ms-client-name: version
schema:
type: string
- name: x-ms-client-request-id
in: header
description: An opaque, globally-unique, client-generated string identifier for the request.
required: false
x-ms-client-name: clientRequestId
schema:
type: string
format: uuid
- name: messageId
in: path
description: The ID of the queue message.
required: true
schema:
type: string
- name: popreceipt
in: query
description: 'An opaque value required to delete the message. If deletion fails using this
PopReceipt then the message has been dequeued by another client.'
required: true
x-ms-client-name: popReceipt
schema:
type: string
- name: timeout
in: query
description: 'The timeout parameter is expressed in seconds. For more information, see
<a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a>'
required: false
schema:
type: integer
format: int32
minimum: 0
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
headers:
Date:
description: UTC date/time value generated by the service that indicates the time at which the response was initiated.
schema:
type: string
format: date-time-rfc7231
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-request-id:
description: An opaque, globally-unique, server-generated string identifier for the request.
schema:
type: string
format: uuid
x-ms-version:
description: Specifies the version of the operation to use for this request.
schema:
type: string
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: The error code.
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/Error'
tags:
- Messages
summary: Queue delete message
x-summary-source: derived
components:
schemas:
Error:
type: object
description: The error response.
properties:
Code:
$ref: '#/components/schemas/StorageErrorCode'
description: The error code.
x-ms-client-name: code
Message:
type: string
description: The error message.
x-ms-client-name: message
StorageErrorCode:
type: string
description: Error codes returned by the service
enum:
- AccountAlreadyExists
- AccountBeingCreated
- AccountIsDisabled
- AuthenticationFailed
- AuthorizationFailure
- ConditionHeadersNotSupported
- ConditionNotMet
- EmptyMetadataKey
- InsufficientAccountPermissions
- InternalError
- InvalidAuthenticationInfo
- InvalidHeaderValue
- InvalidHttpVerb
- InvalidInput
- InvalidMd5
- InvalidMetadata
- InvalidQueryParameterValue
- InvalidRange
- InvalidResourceName
- InvalidUri
- InvalidXmlDocument
- InvalidXmlNodeValue
- Md5Mismatch
- MetadataTooLarge
- MissingContentLengthHeader
- MissingRequiredQueryParameter
- MissingRequiredHeader
- MissingRequiredXmlNode
- MultipleConditionHeadersNotSupported
- OperationTimedOut
- OutOfRangeInput
- OutOfRangeQueryParameterValue
- RequestBodyTooLarge
- ResourceTypeMismatch
- RequestUrlFailedToParse
- ResourceAlreadyExists
- ResourceNotFound
- ServerBusy
- UnsupportedHeader
- UnsupportedXmlNode
- UnsupportedQueryParameter
- UnsupportedHttpVerb
- InvalidMarker
- MessageNotFound
- MessageTooLarge
- PopReceiptMismatch
- QueueAlreadyExists
- QueueBeingDeleted
- QueueDisabled
- QueueNotEmpty
- QueueNotFound
- AuthorizationSourceIPMismatch
- AuthorizationProtocolMismatch
- AuthorizationPermissionMismatch
- AuthorizationServiceMismatch
- AuthorizationResourceTypeMismatch
- FeatureVersionMismatch
x-ms-enum:
name: StorageErrorCode
modelAsString: true
values:
- name: AccountAlreadyExists
value: AccountAlreadyExists
description: AccountAlreadyExists
- name: AccountBeingCreated
value: AccountBeingCreated
description: AccountBeingCreated
- name: AccountIsDisabled
value: AccountIsDisabled
description: AccountIsDisabled
- name: AuthenticationFailed
value: AuthenticationFailed
description: AuthenticationFailed
- name: AuthorizationFailure
value: AuthorizationFailure
description: AuthorizationFailure
- name: ConditionHeadersNotSupported
value: ConditionHeadersNotSupported
description: ConditionHeadersNotSupported
- name: ConditionNotMet
value: ConditionNotMet
description: ConditionNotMet
- name: EmptyMetadataKey
value: EmptyMetadataKey
description: EmptyMetadataKey
- name: InsufficientAccountPermissions
value: InsufficientAccountPermissions
description: InsufficientAccountPermissions
- name: InternalError
value: InternalError
description: InternalError
- name: InvalidAuthenticationInfo
value: InvalidAuthenticationInfo
description: InvalidAuthenticationInfo
- name: InvalidHeaderValue
value: InvalidHeaderValue
description: InvalidHeaderValue
- name: InvalidHttpVerb
value: InvalidHttpVerb
description: InvalidHttpVerb
- name: InvalidInput
value: InvalidInput
description: InvalidInput
- name: InvalidMd5
value: InvalidMd5
description: InvalidMd5
- name: InvalidMetadata
value: InvalidMetadata
description: InvalidMetadata
- name: InvalidQueryParameterValue
value: InvalidQueryParameterValue
description: InvalidQueryParameterValue
- name: InvalidRange
value: InvalidRange
description: InvalidRange
- name: InvalidResourceName
value: InvalidResourceName
description: InvalidResourceName
- name: InvalidUri
value: InvalidUri
description: InvalidUri
- name: InvalidXmlDocument
value: InvalidXmlDocument
description: InvalidXmlDocument
- name: InvalidXmlNodeValue
value: InvalidXmlNodeValue
description: InvalidXmlNodeValue
- name: Md5Mismatch
value: Md5Mismatch
description: Md5Mismatch
- name: MetadataTooLarge
value: MetadataTooLarge
description: MetadataTooLarge
- name: MissingContentLengthHeader
value: MissingContentLengthHeader
description: MissingContentLengthHeader
- name: MissingRequiredQueryParameter
value: MissingRequiredQueryParameter
description: MissingRequiredQueryParameter
- name: MissingRequiredHeader
value: MissingRequiredHeader
description: MissingRequiredHeader
- name: MissingRequiredXmlNode
value: MissingRequiredXmlNode
description: MissingRequiredXmlNode
- name: MultipleConditionHeadersNotSupported
value: MultipleConditionHeadersNotSupported
description: MultipleConditionHeadersNotSupported
- name: OperationTimedOut
value: OperationTimedOut
description: OperationTimedOut
- name: OutOfRangeInput
value: OutOfRangeInput
description: OutOfRangeInput
- name: OutOfRangeQueryParameterValue
value: OutOfRangeQueryParameterValue
description: OutOfRangeQueryParameterValue
- name: RequestBodyTooLarge
value: RequestBodyTooLarge
description: RequestBodyTooLarge
- name: ResourceTypeMismatch
value: ResourceTypeMismatch
description: ResourceTypeMismatch
- name: RequestUrlFailedToParse
value: RequestUrlFailedToParse
description: RequestUrlFailedToParse
- name: ResourceAlreadyExists
value: ResourceAlreadyExists
description: ResourceAlreadyExists
- name: ResourceNotFound
value: ResourceNotFound
description: ResourceNotFound
- name: ServerBusy
value: ServerBusy
description: ServerBusy
- name: UnsupportedHeader
value: UnsupportedHeader
description: UnsupportedHeader
- name: UnsupportedXmlNode
value: UnsupportedXmlNode
description: UnsupportedXmlNode
- name: UnsupportedQueryParameter
value: UnsupportedQueryParameter
description: UnsupportedQueryParameter
- name: UnsupportedHttpVerb
value: UnsupportedHttpVerb
description: UnsupportedHttpVerb
- name: InvalidMarker
value: InvalidMarker
description: InvalidMarker
- name: MessageNotFound
value: MessageNotFound
description: MessageNotFound
- name: MessageTooLarge
value: MessageTooLarge
description: MessageTooLarge
- name: PopReceiptMismatch
value: PopReceiptMismatch
description: PopReceiptMismatch
- name: QueueAlreadyExists
value: QueueAlreadyExists
description: QueueAlreadyExists
- name: QueueBeingDeleted
value: QueueBeingDeleted
description: QueueBeingDeleted
- name: QueueDisabled
value: QueueDisabled
description: QueueDisabled
- name: QueueNotEmpty
value: QueueNotEmpty
description: QueueNotEmpty
- name: QueueNotFound
value: QueueNotFound
description: QueueNotFound
- name: AuthorizationSourceIPMismatch
value: AuthorizationSourceIPMismatch
description: AuthorizationSourceIPMismatch
- name: AuthorizationProtocolMismatch
value: AuthorizationProtocolMismatch
description: AuthorizationProtocolMismatch
- name: AuthorizationPermissionMismatch
value: AuthorizationPermissionMismatch
description: AuthorizationPermissionMismatch
- name: AuthorizationServiceMismatch
value: AuthorizationServiceMismatch
description: AuthorizationServiceMismatch
- name: AuthorizationResourceTypeMismatch
value: AuthorizationResourceTypeMismatch
description: AuthorizationResourceTypeMismatch
- name: FeatureVersionMismatch
value: FeatureVersionMismatch
description: FeatureVersionMismatch
SentMessage:
type: object
description: The sent queue message.
properties:
MessageId:
type: string
description: The ID of the message.
x-ms-client-name: messageId
InsertionTime:
type: string
format: date-time-rfc7231
description: The time the message was inserted into the queue.
x-ms-client-name: insertionTime
ExpirationTime:
type: string
format: date-time-rfc7231
description: The time that the message will expire and be automatically deleted.
x-ms-client-name: expirationTime
PopReceipt:
type: string
description: 'An opaque value required to delete the message. If deletion fails using this
PopReceipt then the message has been dequeued by another client.'
x-ms-client-name: popReceipt
TimeNextVisible:
type: string
format: date-time-rfc7231
description: The time that the message will again become visible in the queue.
x-ms-client-name: timeNextVisible
required:
- MessageId
- InsertionTime
- ExpirationTime
- PopReceipt
- TimeNextVisible
xml:
name: QueueMessage
ReceivedMessages:
type: object
description: The response of receive messages.
properties:
QueueMessage:
type: array
description: The list of received messages.
items:
$ref: '#/components/schemas/ReceivedMessage'
xml:
wrapped: false
x-ms-client-name: items
required:
- QueueMessage
xml:
name: QueueMessagesList
ListOfSentMessage:
type: object
description: The response of send message.
properties:
QueueMessage:
type: array
description: The list of sent messages.
items:
$ref: '#/components/schemas/SentMessage'
xml:
wrapped: false
x-ms-client-name: items
required:
- QueueMessage
xml:
name: QueueMessagesList
ReceivedMessage:
type: object
description: The received queue message.
properties:
MessageId:
type: string
description: The ID of the message.
x-ms-client-name: messageId
InsertionTime:
type: string
format: date-time-rfc7231
description: The time the message was inserted into the queue.
x-ms-client-name: insertionTime
ExpirationTime:
type: string
format: date-time-rfc7231
description: The time that the message will expire and be automatically deleted.
x-ms-client-name: expirationTime
PopReceipt:
type: string
description: 'An opaque value required to delete the message. If deletion fails using this
PopReceipt then the message has been dequeued by another client.'
x-ms-client-name: popReceipt
TimeNextVisible:
type: string
format: date-time-rfc7231
description: The time that the message will again become visible in the queue.
x-ms-client-name: timeNextVisible
DequeueCount:
type: integer
format: int64
description: The number of times the message has been dequeued.
x-ms-client-name: dequeueCount
MessageText:
type: string
description: The content of the message.
x-ms-client-name: messageText
required:
- MessageId
- InsertionTime
- ExpirationTime
- PopReceipt
- TimeNextVisible
- DequeueCount
- MessageText
xml:
name: QueueMessage
QueueMessage:
type: object
description: The queue message.
properties:
MessageText:
type: string
description: The content of the message.
x-ms-client-name: messageText
required:
- MessageText
securitySchemes:
OAuth2Auth:
type: oauth2
flows:
implicit:
scopes:
https://storage.azure.com/.default: ''
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
hostTemplate: '{url}'
useSchemePrefix: false
parameters:
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-queue-storage/openapi/microsoft-azure-queue-storage-messages-api-openapi.yml