Microsoft Azure

Microsoft Azure Routesets API

The Routesets API from Microsoft Azure — 3 operation(s) for routesets.

Documentation GitHub OpenAPI

Operations 5

POST /routesets Microsoft Azure Use To Create A Routeset #

GET /routesets Microsoft Azure Use To Get A List Of Routesets #

GET /routesets/{routesetId} Microsoft Azure Use To Get The Details Of A Routeset #

DELETE /routesets/{routesetId} Microsoft Azure Use To Delete A Routeset #

GET /routesets/operations/{operationId} Microsoft Azure Use To Check The Status Of The Routeset Creation Process #

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-routesets-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:
  version: 2023-03-01-preview
  title: Microsoft Azure Azure Maps Routeset Service. Routesets API
  description: APIs for managing routesets.
security:
- AADToken:
  - https://atlas.microsoft.com/.default
- SharedKey: []
- SasToken: []
tags:
- name: Routesets
paths:
  /routesets:
    post:
      summary: Microsoft Azure Use To Create A Routeset
      description: 'The `Create` API is an HTTP `POST` request that allows the caller to create a routeset from a dataset. The routeset is a data structure consumed by the Azure Maps Wayfinding service to discover the shortest paths within a facility.


        The Create Routeset API is a long-running operation.


        Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the Creator for indoor maps article for an introduction to the Azure Maps Creator concepts and tools.


        ### Submit Create Request


        To create a routeset, make a `POST` request with an empty body. The dataset is used as the source of the routeset data, so the `datasetId` query parameter must be included.'
      operationId: microsoftAzureRoutesetCreate
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        'Create a routeset from a previously created dataset ':
          $ref: ./examples/wayfind/Routeset_Create.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/RouteDatasetId'
      - $ref: '#/components/parameters/Description'
      responses:
        '202':
          $ref: ../../../Common/preview/1.0/common.json#/responses/202AsyncV2
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
    get:
      summary: Microsoft Azure Use To Get A List Of Routesets
      description: 'Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the Creator for indoor maps article for an introduction to the Azure Maps Creator concepts and tools.


        ### Submit List Request


        The `List` API is an HTTP `GET` request that allows the caller to fetch a list of all routesets in the current Azure Maps Creator account.'
      operationId: microsoftAzureRoutesetList
      x-ms-examples:
        Enumerate all routesets for a given subscription:
          $ref: ./examples/wayfind/Routeset_List.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/components/parameters/ApiVersion'
      x-ms-pageable:
        itemName: routesets
        nextLinkName: nextLink
      responses:
        '200':
          description: List routeset request completed successfully. The response body contains a list of all routesets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutesetsList'
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
  /routesets/{routesetId}:
    get:
      summary: Microsoft Azure Use To Get The Details Of A Routeset
      description: 'Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the Creator for indoor maps article for an introduction to the Azure Maps Creator concepts and tools.


        ### Submit Get Request


        The `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing routeset, specified by the `routesetId`.'
      operationId: microsoftAzureRoutesetGet
      x-ms-examples:
        Get details for a previously created dataset:
          $ref: ./examples/wayfind/Routeset_Get.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/QueryRoutesetId'
      responses:
        '200':
          description: The get routeset request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Routeset'
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
    delete:
      summary: Microsoft Azure Use To Delete A Routeset
      description: 'Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDKs. See the Creator for indoor maps article for an introduction to the Azure Maps Creator concepts and tools.


        ### Submit Delete Request


        The `Delete` API is an HTTP `DELETE` request sent with the `routesetId` of the routeset to delete.'
      operationId: microsoftAzureRoutesetDelete
      x-ms-examples:
        Delete an existing routeset:
          $ref: ./examples/wayfind/Routeset_Delete.json
      parameters:
      - $ref: '#/components/parameters/DeleteRoutesetId'
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '204':
          description: Routeset delete request completed successfully.
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
  /routesets/operations/{operationId}:
    get:
      summary: Microsoft Azure Use To Check The Status Of The Routeset Creation Process
      description: 'The `Get Operation` API is an HTTP `GET` request used to check the status of the routeset creation process and retrieve the `routesetId`.


        ### Submit Operations Request


        To view the current progress of a routeset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.


        ### Operation Response


        While in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.'
      operationId: microsoftAzureRoutesetGetoperation
      x-ms-examples:
        Get the status of an operation which is still running:
          $ref: ./examples/wayfind/Routeset_GetOperationStillRunning.json
        Get the status of an operation which has finished successfully:
          $ref: ./examples/wayfind/Routeset_GetOperation.json
      parameters:
      - $ref: ../../../Common/preview/1.0/common.json#/parameters/ClientId
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/OperationId'
      responses:
        '200':
          description: The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.
          headers:
            Resource-Location:
              description: If successful, a URI where details on the newly created resource can be found.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: ./tileset.json#/definitions/LongRunningOperationResult
        default:
          $ref: ../../../Common/preview/1.0/common.json#/responses/default
      tags:
      - Routesets
components:
  parameters:
    DeleteRoutesetId:
      name: routesetId
      description: The ID of the routeset to delete.
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    QueryRoutesetId:
      name: routesetId
      description: The ID of the routeset to query for.
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    Description:
      name: description
      description: User provided description of the routeset.
      in: query
      x-ms-parameter-location: client
      schema:
        type: string
    OperationId:
      name: operationId
      description: The ID used to query the status of the routeset creation.
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersion:
      name: api-version
      description: Version number of Azure Maps API.
      in: query
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
    RouteDatasetId:
      name: datasetId
      in: query
      description: The ID of the dataset from which to create the routeset(s). A routeset is created for each facility in the dataset.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    Routeset:
      description: Detailed information for the routeset.
      type: object
      properties:
        routesetId:
          description: The unique ID of the routeset.
          type: string
          readOnly: true
        datasetId:
          description: The ID of the dataset used to create this routeset.
          type: string
          readOnly: true
        description:
          description: The description code for the building with the ontology version number.
          type: string
          readOnly: true
        facilities:
          description: The facility information and building level ordinal numbers.
          type: array
          items:
            $ref: '#/components/schemas/FacilityDetails'
          x-ms-identifiers: []
          readOnly: true
        created:
          description: The date and time the routeset object was created.
          type: string
          format: date-time
          readOnly: true
    RoutesetsList:
      description: The response model for the Routeset List API. Returns the list of all routesets.
      type: object
      properties:
        routesets:
          description: The list of all routesets.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Routeset'
        nextLink:
          description: If present, the location of the next page of data.
          type: string
          readOnly: true
    FacilityDetails:
      description: Details about each facility in the routeset.
      type: object
      properties:
        facilityId:
          description: The identifier of the structure this routeset was created from.
          type: string
          readOnly: true
        levelOrdinals:
          description: The level identifiers within this facility.
          type: array
          items:
            type: number
          x-ms-identifiers: []
          readOnly: true
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://atlas.microsoft.com/.default: https://atlas.microsoft.com/.default
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts."
    SharedKey:
      type: apiKey
      description: "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored."
      name: subscription-key
      in: query
    SasToken:
      type: apiKey
      description: "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token."
      name: SAS Token
      in: header
x-ms-parameterized-host:
  hostTemplate: '{geography}.atlas.microsoft.com'
  parameters:
  - $ref: ../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation