Azure Kubernetes Service Snapshots API

The Snapshots API from Azure Kubernetes Service — 3 operation(s) for snapshots.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots Snapshots list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots Snapshots list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName} Snapshots get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName} Snapshots create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName} Snapshots update tags #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName} Snapshots delete #

Documentation

Specifications

Schemas & Data

Other Resources

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-kubernetes-service:microsoft-azure-kubernetes-service-snapshots-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 Specification

microsoft-azure-kubernetes-service-snapshots-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ContainerServiceClient Snapshots API
  version: '2026-09-01'
  description: The Container Service Client.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Snapshots
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots:
    get:
      operationId: Snapshots_List
      tags:
      - Snapshots
      description: Gets a list of snapshots in the specified subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Snapshots list
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots:
    get:
      operationId: Snapshots_ListByResourceGroup
      tags:
      - Snapshots
      description: Lists snapshots in the specified subscription and resource group.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Snapshots list by resource group
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}
  : get:
      operationId: Snapshots_Get
      tags:
      - Snapshots
      description: Gets a snapshot.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: resourceName
        in: path
        description: The name of the managed cluster resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Snapshots get
      x-summary-source: derived
    put:
      operationId: Snapshots_CreateOrUpdate
      tags:
      - Snapshots
      description: Creates or updates a snapshot.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: resourceName
        in: path
        description: The name of the managed cluster resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
      responses:
        '200':
          description: Resource 'Snapshot' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '201':
          description: Resource 'Snapshot' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Snapshot'
        description: The snapshot to create or update.
        required: true
      summary: Snapshots create or update
      x-summary-source: derived
    patch:
      operationId: Snapshots_UpdateTags
      tags:
      - Snapshots
      description: Updates tags on a snapshot.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: resourceName
        in: path
        description: The name of the managed cluster resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsObject'
        description: Parameters supplied to the Update snapshot Tags operation.
        required: true
      summary: Snapshots update tags
      x-summary-source: derived
    delete:
      operationId: Snapshots_Delete
      tags:
      - Snapshots
      description: Deletes a snapshot.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: resourceName
        in: path
        description: The name of the managed cluster resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Snapshots delete
      x-summary-source: derived
components:
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  schemas:
    TagsObject:
      type: object
      description: Tags object for patch operations.
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    SnapshotListResult:
      type: object
      description: The response of a Snapshot list operation.
      properties:
        value:
          type: array
          description: The Snapshot items on this page
          items:
            $ref: '#/components/schemas/Snapshot'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    OSSKU:
      type: string
      description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
      enum:
      - Ubuntu
      - AzureLinux
      - AzureLinux3
      - CBLMariner
      - Windows2019
      - Windows2022
      - Ubuntu2204
      - Windows2025
      - Ubuntu2404
      - AzureContainerLinux
      x-ms-enum:
        name: OSSKU
        modelAsString: true
        values:
        - name: Ubuntu
          value: Ubuntu
          description: Use Ubuntu as the OS for node images.
        - name: AzureLinux
          value: AzureLinux
          description: Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information.
        - name: AzureLinux3
          value: AzureLinux3
          description: Use AzureLinux3 as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. For limitations, visit https://aka.ms/aks/node-images. For OS migration guidance, see https://aka.ms/aks/upgrade-os-version.
        - name: CBLMariner
          value: CBLMariner
          description: Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead.
        - name: Windows2019
          value: Windows2019
          description: Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa.
        - name: Windows2022
          value: Windows2022
          description: Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa.
        - name: Ubuntu2204
          value: Ubuntu2204
          description: Use Ubuntu2204 as the OS for node images, however, Ubuntu 22.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see https://aka.ms/aks/supported-ubuntu-versions
        - name: Windows2025
          value: Windows2025
          description: Use Windows2025 as the OS for node images. Unsupported for system node pools. Windows2025 supports Windows2022 and Windows 2025 containers; it cannot run Windows2019 containers and vice versa.
        - name: Ubuntu2404
          value: Ubuntu2404
          description: Use Ubuntu2404 as the OS for node images, however, Ubuntu 24.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions
        - name: AzureContainerLinux
          value: AzureContainerLinux
          description: Use Azure Container Linux as the OS for node images. Azure Container Linux is a container-optimized, security-focused Linux OS built on Azure Linux, with an immutable filesystem. ACL is derived from the Flatcar Container Linux project, building on Flatcar's proven container-first, immutable design, while adding Azure Linux packages, servicing, and deep integration with the Azure and AKS lifecycle. For more information, see https://aka.ms/azurecontainerlinux
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
    CreationData:
      type: object
      description: Data used when creating a target resource from a source resource.
      properties:
        sourceResourceId:
          type: string
          format: arm-id
          description: This is the ARM ID of the source object to be used to create the target object.
    SnapshotProperties:
      type: object
      description: Properties used to configure a node pool snapshot.
      properties:
        creationData:
          $ref: '#/components/schemas/CreationData'
          description: CreationData to be used to specify the source agent pool resource ID to create this snapshot.
        snapshotType:
          type: string
          description: The type of a snapshot. The default is NodePool.
          default: NodePool
          enum:
          - NodePool
          x-ms-enum:
            name: SnapshotType
            modelAsString: true
            values:
            - name: NodePool
              value: NodePool
              description: The snapshot is a snapshot of a node pool.
        kubernetesVersion:
          type: string
          description: The version of Kubernetes.
          readOnly: true
        nodeImageVersion:
          type: string
          description: The version of node image.
          readOnly: true
        osType:
          type: string
          description: The operating system type. The default is Linux.
          default: Linux
          enum:
          - Linux
          - Windows
          x-ms-enum:
            name: OSType
            modelAsString: true
            values:
            - name: Linux
              value: Linux
              description: Use Linux.
            - name: Windows
              value: Windows
              description: Use Windows.
          readOnly: true
        osSku:
          $ref: '#/components/schemas/OSSKU'
          description: Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
          readOnly: true
        vmSize:
          type: string
          description: The size of the VM.
          readOnly: true
        enableFIPS:
          type: boolean
          description: Whether to use a FIPS-enabled OS.
          readOnly: true
    Snapshot:
      type: object
      description: A node pool snapshot resource.
      properties:
        properties:
          $ref: '#/components/schemas/SnapshotProperties'
          description: Properties of a snapshot.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
          x-ms-identifiers:
          - message
          - target
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
          x-ms-identifiers: []
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.