Azure Traffic Manager Subscriptions API

The Subscriptions API from Azure Traffic Manager — 3 operation(s) for subscriptions.

GitHub OpenAPI

Operations 6

POST /subscriptions/{subscriptionId}/providers/Microsoft.Network/checkTrafficManagerNameAvailabilityV2 Profiles check traffic manager name availability V2 #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName} Endpoints get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName} Endpoints create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName} Endpoints update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName} Endpoints delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType} Heat map get #

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-traffic-manager:microsoft-azure-traffic-manager-subscriptions-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-traffic-manager-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TrafficManagerManagementClient Subscriptions API
  version: '2026-09-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subscriptions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/checkTrafficManagerNameAvailabilityV2:
    post:
      operationId: Profiles_checkTrafficManagerNameAvailabilityV2
      description: Checks the availability of a Traffic Manager Relative DNS name.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficManagerNameAvailability'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckTrafficManagerRelativeDnsNameAvailabilityParameters'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Profiles check traffic manager name availability V2
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
  : get:
      operationId: Endpoints_Get
      description: Gets a Traffic Manager endpoint.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The name of the Traffic Manager profile.
        required: true
        schema:
          type: string
      - name: endpointType
        in: path
        description: The type of the Traffic Manager endpoint.
        required: true
        x-ms-enum:
          name: EndpointType
          modelAsString: false
        schema:
          type: string
          enum:
          - AzureEndpoints
          - ExternalEndpoints
          - NestedEndpoints
      - name: endpointName
        in: path
        description: The name of the Traffic Manager endpoint.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Subscriptions
      summary: Endpoints get
      x-summary-source: derived
    put:
      operationId: Endpoints_CreateOrUpdate
      description: Create or update a Traffic Manager endpoint.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The name of the Traffic Manager profile.
        required: true
        schema:
          type: string
      - name: endpointType
        in: path
        description: The type of the Traffic Manager endpoint.
        required: true
        x-ms-enum:
          name: EndpointType
          modelAsString: false
        schema:
          type: string
          enum:
          - AzureEndpoints
          - ExternalEndpoints
          - NestedEndpoints
      - name: endpointName
        in: path
        description: The name of the Traffic Manager endpoint.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Endpoint' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '201':
          description: Resource 'Endpoint' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
        description: The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation.
        required: true
      tags:
      - Subscriptions
      summary: Endpoints create or update
      x-summary-source: derived
    patch:
      operationId: Endpoints_Update
      description: Update a Traffic Manager endpoint.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The name of the Traffic Manager profile.
        required: true
        schema:
          type: string
      - name: endpointType
        in: path
        description: The type of the Traffic Manager endpoint.
        required: true
        x-ms-enum:
          name: EndpointType
          modelAsString: false
        schema:
          type: string
          enum:
          - AzureEndpoints
          - ExternalEndpoints
          - NestedEndpoints
      - name: endpointName
        in: path
        description: The name of the Traffic Manager endpoint.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
        description: The Traffic Manager endpoint parameters supplied to the Update operation.
        required: true
      tags:
      - Subscriptions
      summary: Endpoints update
      x-summary-source: derived
    delete:
      operationId: Endpoints_Delete
      description: Deletes a Traffic Manager endpoint.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The name of the Traffic Manager profile.
        required: true
        schema:
          type: string
      - name: endpointType
        in: path
        description: The type of the Traffic Manager endpoint.
        required: true
        x-ms-enum:
          name: EndpointType
          modelAsString: false
        schema:
          type: string
          enum:
          - AzureEndpoints
          - ExternalEndpoints
          - NestedEndpoints
      - name: endpointName
        in: path
        description: The name of the Traffic Manager endpoint.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteOperationResult'
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Subscriptions
      summary: Endpoints delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}
  : get:
      operationId: HeatMap_Get
      description: Gets latest heatmap for Traffic Manager profile.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The name of the Traffic Manager profile.
        required: true
        schema:
          type: string
      - name: heatMapType
        in: path
        description: The type of the heatmap.
        required: true
        x-ms-enum:
          name: HeatMapType
          modelAsString: false
        schema:
          type: string
          enum:
          - default
      - name: topLeft
        in: query
        description: The top left latitude,longitude pair of the rectangular viewport to query for.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: number
            format: double
          maxItems: 2
          minItems: 2
      - name: botRight
        in: query
        description: The bottom right latitude,longitude pair of the rectangular viewport to query for.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: number
            format: double
          maxItems: 2
          minItems: 2
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeatMapModel'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Subscriptions
      summary: Heat map get
      x-summary-source: derived
components:
  schemas:
    CloudErrorBody:
      type: object
      description: The content of an error returned by the Azure Resource Manager
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
        target:
          type: string
          description: Error target
        details:
          type: array
          description: Error details
          items:
            $ref: '#/components/schemas/CloudErrorBody'
      x-ms-external: true
    EndpointProperties:
      type: object
      description: Class representing a Traffic Manager endpoint properties.
      properties:
        targetResourceId:
          type: string
          description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
        target:
          type: string
          description: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
        endpointStatus:
          $ref: '#/components/schemas/EndpointStatus'
          description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
        weight:
          type: integer
          format: int64
          description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
        priority:
          type: integer
          format: int64
          description: The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter.  If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
        endpointLocation:
          type: string
          description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
        endpointMonitorStatus:
          $ref: '#/components/schemas/EndpointMonitorStatus'
          description: The monitoring status of the endpoint.
        minChildEndpoints:
          type: integer
          format: int64
          description: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
        minChildEndpointsIPv4:
          type: integer
          format: int64
          description: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
        minChildEndpointsIPv6:
          type: integer
          format: int64
          description: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
        geoMapping:
          type: array
          description: The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
          items:
            type: string
        subnets:
          type: array
          description: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.
          items:
            $ref: '#/components/schemas/EndpointPropertiesSubnetsItem'
        customHeaders:
          type: array
          description: List of custom headers.
          items:
            $ref: '#/components/schemas/EndpointPropertiesCustomHeadersItem'
        alwaysServe:
          $ref: '#/components/schemas/AlwaysServe'
          description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    EndpointPropertiesSubnetsItem:
      type: object
      description: Subnet first address, scope, and/or last address.
      properties:
        first:
          type: string
          description: First address in the subnet.
        last:
          type: string
          description: Last address in the subnet.
        scope:
          type: integer
          format: int32
          description: Block size (number of leading bits in the subnet mask).
    ProxyResource:
      type: object
      description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
      allOf:
      - $ref: '#/components/schemas/Resource'
    CheckTrafficManagerRelativeDnsNameAvailabilityParameters:
      type: object
      description: Parameters supplied to check Traffic Manager name operation.
      properties:
        name:
          type: string
          description: The name of the resource.
        type:
          type: string
          description: The type of the resource.
    Endpoint:
      type: object
      description: Class representing a Traffic Manager endpoint.
      properties:
        properties:
          $ref: '#/components/schemas/EndpointProperties'
          description: The properties of the Traffic Manager endpoint.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    CloudError:
      type: object
      description: An error returned by the Azure Resource Manager
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: The content of the error.
      x-ms-external: true
    EndpointPropertiesCustomHeadersItem:
      type: object
      description: Custom header name and value.
      properties:
        name:
          type: string
          description: Header name.
        value:
          type: string
          description: Header value.
    TrafficFlow:
      type: object
      description: Class representing a Traffic Manager HeatMap traffic flow properties.
      properties:
        sourceIp:
          type: string
          description: The IP address that this query experience originated from.
        latitude:
          type: number
          format: double
          description: The approximate latitude that these queries originated from.
        longitude:
          type: number
          format: double
          description: The approximate longitude that these queries originated from.
        queryExperiences:
          type: array
          description: The query experiences produced in this HeatMap calculation.
          items:
            $ref: '#/components/schemas/QueryExperience'
    QueryExperience:
      type: object
      description: Class representing a Traffic Manager HeatMap query experience properties.
      properties:
        endpointId:
          type: integer
          format: int32
          description: The id of the endpoint from the 'endpoints' array which these queries were routed to.
        queryCount:
          type: integer
          format: int32
          description: The number of queries originating from this location.
        latency:
          type: number
          format: double
          description: The latency experienced by queries originating from this location.
      required:
      - endpointId
      - queryCount
    HeatMapModel:
      type: object
      description: Class representing a Traffic Manager HeatMap.
      properties:
        properties:
          $ref: '#/components/schemas/HeatMapProperties'
          description: The properties of the Traffic Manager HeatMap.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    TrafficManagerNameAvailability:
      type: object
      description: Class representing a Traffic Manager Name Availability response.
      properties:
        name:
          type: string
          description: The relative name.
        type:
          type: string
          description: Traffic Manager profile resource type.
        nameAvailable:
          type: boolean
          description: Describes whether the relative name is available or not.
        reason:
          type: string
          description: The reason why the name is not available, when applicable.
        message:
          type: string
          description: Descriptive message that explains why the name is not available, when applicable.
    EndpointMonitorStatus:
      type: string
      description: The monitoring status of the endpoint.
      enum:
      - CheckingEndpoint
      - Online
      - Degraded
      - Disabled
      - Inactive
      - Stopped
      - Unmonitored
      x-ms-enum:
        name: EndpointMonitorStatus
        modelAsString: true
        values:
        - name: CheckingEndpoint
          value: CheckingEndpoint
        - name: Online
          value: Online
        - name: Degraded
          value: Degraded
        - name: Disabled
          value: Disabled
        - name: Inactive
          value: Inactive
        - name: Stopped
          value: Stopped
        - name: Unmonitored
          value: Unmonitored
    EndpointStatus:
      type: string
      description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
      enum:
      - Enabled
      - Disabled
      x-ms-enum:
        name: EndpointStatus
        modelAsString: true
        values:
        - name: Enabled
          value: Enabled
        - name: Disabled
          value: Disabled
    HeatMapEndpoint:
      type: object
      description: Class which is a sparse representation of a Traffic Manager endpoint.
      properties:
        resourceId:
          type: string
          description: The ARM Resource ID of this Traffic Manager endpoint.
        endpointId:
          type: integer
          format: int32
          description: A number uniquely identifying this endpoint in query experiences.
    DeleteOperationResult:
      type: object
      description: The result of the request or operation.
      properties:
        boolean:
          type: boolean
          description: The result of the operation or request.
          readOnly: true
          x-ms-client-name: operationResult
    Resource:
      type: object
      description: The core properties of ARM resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
        name:
          type: string
          description: The name of the resource
        type:
          type: string
          description: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
      x-ms-azure-resource: true
    AlwaysServe:
      type: string
      description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
      enum:
      - Enabled
      - Disabled
      x-ms-enum:
        name: AlwaysServe
        modelAsString: true
        values:
        - name: Enabled
          value: Enabled
        - name: Disabled
          value: Disabled
    HeatMapProperties:
      type: object
      description: Class representing a Traffic Manager HeatMap properties.
      properties:
        startTime:
          type: string
          format: date-time
          description: The beginning of the time window for this HeatMap, inclusive.
        endTime:
          type: string
          format: date-time
          description: The ending of the time window for this HeatMap, exclusive.
        endpoints:
          type: array
          description: The endpoints used in this HeatMap calculation.
          items:
            $ref: '#/components/schemas/HeatMapEndpoint'
        trafficFlows:
          type: array
          description: The traffic flows produced in this HeatMap calculation.
          items:
            $ref: '#/components/schemas/TrafficFlow'
  parameters:
    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
    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
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  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.