Azure Queue Storage Queue API
The queue API from Azure Queue Storage — 3 operation(s) for queue.
The queue API from Azure Queue Storage — 3 operation(s) for queue.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/microsoft-azure-queue-storage:microsoft-azure-queue-storage-queue-api"
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.
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 Storage Queue API
version: '2026-04-06'
x-ms-code-generation-settings:
header: MIT
strictSpecAdherence: false
description: Azure Queue Storage data-plane REST API (version 2026-04-06), converted from Swagger 2.0 to OpenAPI 3.0.
x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/storage/data-plane/QueueStorage/stable/2026-04-06/queue.json
x-ownership: Published by Microsoft in its official Azure/azure-rest-api-specs repository; info.title Azure Queue Storage; host template {accountName}.queue.core.windows.net is the documented Queue service endpoint.
servers:
- url: https://{accountName}.queue.core.windows.net
variables:
accountName:
default: myaccount
description: Storage account name
tags:
- name: Queue
paths:
/{queueName}:
parameters:
- $ref: '#/components/parameters/QueueName'
delete:
tags:
- Queue
operationId: Queue_Delete
description: operation permanently deletes the specified queue
parameters:
- $ref: '#/components/parameters/Timeout'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ClientRequestId'
responses:
'204':
description: No Content
headers:
x-ms-request-id:
x-ms-client-name: RequestId
description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
schema:
type: string
x-ms-version:
x-ms-client-name: Version
description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
schema:
type: string
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-rfc1123
default:
description: Failure
headers:
x-ms-error-code:
x-ms-client-name: ErrorCode
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/StorageError'
summary: Queue delete
x-summary-source: derived
/{queueName}?comp=metadata:
parameters:
- $ref: '#/components/parameters/QueueName'
- name: comp
description: comp
in: query
required: true
schema:
type: string
enum:
- metadata
get:
tags:
- Queue
operationId: Queue_GetProperties
description: Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs.
parameters:
- $ref: '#/components/parameters/Timeout'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ClientRequestId'
responses:
'200':
description: Success.
headers:
x-ms-meta:
x-ms-client-name: Metadata
x-ms-header-collection-prefix: x-ms-meta-
schema:
type: string
x-ms-approximate-messages-count:
x-ms-client-name: ApproximateMessagesCount
description: The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.
schema:
type: integer
format: int64
x-ms-request-id:
x-ms-client-name: RequestId
description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
schema:
type: string
x-ms-version:
x-ms-client-name: Version
description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
schema:
type: string
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-rfc1123
default:
description: Failure
headers:
x-ms-error-code:
x-ms-client-name: ErrorCode
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/StorageError'
summary: Queue get properties
x-summary-source: derived
put:
tags:
- Queue
operationId: Queue_SetMetadata
description: sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs.
parameters:
- $ref: '#/components/parameters/Timeout'
- $ref: '#/components/parameters/Metadata'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ClientRequestId'
responses:
'204':
description: No Content
headers:
x-ms-request-id:
x-ms-client-name: RequestId
description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
schema:
type: string
x-ms-version:
x-ms-client-name: Version
description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
schema:
type: string
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-rfc1123
default:
description: Failure
headers:
x-ms-error-code:
x-ms-client-name: ErrorCode
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/StorageError'
summary: Queue set metadata
x-summary-source: derived
/{queueName}?comp=acl:
parameters:
- $ref: '#/components/parameters/QueueName'
- name: comp
description: comp
in: query
required: true
schema:
type: string
enum:
- acl
get:
tags:
- Queue
operationId: Queue_GetAccessPolicy
description: returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
parameters:
- $ref: '#/components/parameters/Timeout'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ClientRequestId'
responses:
'200':
description: Success
headers:
x-ms-request-id:
x-ms-client-name: RequestId
description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
schema:
type: string
x-ms-version:
x-ms-client-name: Version
description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
schema:
type: string
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-rfc1123
content:
application/xml:
schema:
$ref: '#/components/schemas/SignedIdentifiers'
default:
description: Failure
headers:
x-ms-error-code:
x-ms-client-name: ErrorCode
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/StorageError'
summary: Queue get access policy
x-summary-source: derived
put:
tags:
- Queue
operationId: Queue_SetAccessPolicy
description: sets stored access policies for the queue that may be used with Shared Access Signatures
parameters:
- $ref: '#/components/parameters/Timeout'
- $ref: '#/components/parameters/ApiVersionParameter'
- $ref: '#/components/parameters/ClientRequestId'
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/SignedIdentifiers'
description: the acls for the queue
x-ms-parameter-location: method
responses:
'204':
description: No Content
headers:
x-ms-request-id:
x-ms-client-name: RequestId
description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
schema:
type: string
x-ms-version:
x-ms-client-name: Version
description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
schema:
type: string
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-rfc1123
default:
description: Failure
headers:
x-ms-error-code:
x-ms-client-name: ErrorCode
schema:
type: string
content:
application/xml:
schema:
$ref: '#/components/schemas/StorageError'
summary: Queue set access policy
x-summary-source: derived
components:
parameters:
QueueName:
name: queueName
in: path
required: true
x-ms-parameter-location: method
description: The queue name.
schema:
type: string
ApiVersionParameter:
name: x-ms-version
x-ms-parameter-location: client
x-ms-client-name: version
in: header
required: true
description: Specifies the version of the operation to use for this request.
schema:
type: string
ClientRequestId:
name: x-ms-client-request-id
x-ms-client-name: requestId
in: header
required: false
x-ms-parameter-location: method
description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
schema:
type: string
Timeout:
name: timeout
in: query
required: false
x-ms-parameter-location: method
description: The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations>Setting Timeouts for Queue Service Operations.</a>
schema:
type: integer
minimum: 0
Metadata:
name: x-ms-meta
x-ms-client-name: metadata
in: header
required: false
x-ms-parameter-location: method
description: Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers.
x-ms-header-collection-prefix: x-ms-meta-
schema:
type: string
schemas:
SignedIdentifiers:
description: a collection of signed identifiers
type: array
items:
$ref: '#/components/schemas/SignedIdentifier'
xml:
wrapped: true
name: SignedIdentifiers
StorageError:
type: object
properties:
Message:
type: string
AccessPolicy:
type: object
description: An Access policy
properties:
Start:
description: the date-time the policy is active
type: string
format: date-time
Expiry:
description: the date-time the policy expires
type: string
format: date-time
Permission:
description: the permissions for the acl policy
type: string
SignedIdentifier:
description: signed identifier
type: object
required:
- Id
- AccessPolicy
properties:
Id:
type: string
description: a unique id
AccessPolicy:
$ref: '#/components/schemas/AccessPolicy'
securitySchemes:
queue_shared_key:
type: apiKey
name: Authorization
in: header