Aembit

Aembit Routing API

The Routing API from Aembit — 2 operation(s) for routing.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/routings/{id} Get a routing · Get a Routing #
Ask an LLM
“Which proxy URL does a routing send traffic through?”
“Can I read one routing by its ID?”
Tell an agent
Show routing {id}.
Get the proxy settings of routing {id}.
PATCH /api/v1/routings/{id} Rename or toggle a routing · Patch a Routing #
Ask an LLM
“Can I disable a routing without deleting it?”
“Is it possible to rename a routing?”
Tell an agent
Deactivate routing {id}.
Rename routing {id} to {name}.
GET /api/v1/routings List routings · Get a page of Routings #
Ask an LLM
“Which routings are configured in my tenant?”
“Can I filter the list of routings?”
Tell an agent
List my routings.
List routings matching {filter}.
POST /api/v1/routings Create a routing · Create a Routing #
Ask an LLM
“How do I route a resource set's traffic through a proxy?”
“What does a new routing need?”
Tell an agent
Create routing {name} through proxy {proxyUrl} for resource set {resourceSetId}.
Add a new routing called {name} with proxy URL {proxyUrl}.
PUT /api/v1/routings Replace a routing · Update a Routing #
Ask an LLM
“How do I change the proxy URL of an existing routing?”
“Can I move a routing to another resource set?”
Tell an agent
Update routing {name} to use proxy {proxyUrl}.
Replace routing {name} for resource set {resourceSetId}.

Documentation

📖
Documentation
https://docs.aembit.io/dev-guide/api/cloud/
📖
APIReference
https://docs.aembit.io/dev-guide/api/cloud/api-reference-cloud/
📖
Documentation
https://docs.aembit.io/dev-guide/api/edge/
📖
APIReference
https://docs.aembit.io/dev-guide/api/edge/api-reference-edge/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aembit/refs/heads/main/openapi/aembit-routing-api-openapi.yml

Other Resources

🔗
SDKs
https://docs.aembit.io/dev-guide/sdk/edge/

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/aembit:aembit-routing-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

aembit-routing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aembit Cloud Routing API
  version: v1
servers:
- url: https://{tenant}.aembit.io
  variables:
    tenant:
      default: tenant
      description: Aembit Tenant ID
security:
- {}
tags:
- name: Routing
paths:
  /api/v1/routings/{id}:
    get:
      tags:
      - Routing
      summary: Get a Routing
      description: Get a Routing identified by its ID.
      operationId: get-routing
      parameters:
      - name: id
        in: path
        description: ID of Routing
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Routing
          content:
            application/json:
              schema:
                description: Individual Routing
                $ref: '#/components/schemas/RoutingDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    patch:
      tags:
      - Routing
      summary: Patch a Routing
      description: Patch a Routing identified by its ID.
      operationId: patch-routing
      parameters:
      - name: id
        in: path
        description: ID of Routing
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: RoutingPatchDTO
        content:
          application/json:
            schema:
              description: Patch request for an individual Routing
              $ref: '#/components/schemas/RoutingPatchDTO'
      responses:
        '200':
          description: Patched Routing
          content:
            application/json:
              schema:
                description: Individual Routing
                $ref: '#/components/schemas/RoutingDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
  /api/v1/routings:
    get:
      tags:
      - Routing
      summary: Get a page of Routings
      description: Get a page of Routings.
      operationId: get-routings
      parameters:
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - name: per-page
        in: query
        schema:
          type: integer
          format: int32
          default: 100
      - name: filter
        in: query
        schema:
          type: string
          default: ''
      - name: order
        in: query
        schema:
          type: string
          default: ''
      - name: group-by
        in: query
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Page of Routings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingDTOListDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    post:
      tags:
      - Routing
      summary: Create a Routing
      description: Create a Routing.
      operationId: post-routing
      requestBody:
        description: RoutingDTO
        content:
          application/json:
            schema:
              description: Individual Routing
              $ref: '#/components/schemas/RoutingDTO'
      responses:
        '201':
          description: Created Routing
          content:
            application/json:
              schema:
                description: Individual Routing
                $ref: '#/components/schemas/RoutingDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    put:
      tags:
      - Routing
      summary: Update a Routing
      description: Update a Routing.
      operationId: put-routing
      requestBody:
        description: RoutingDTO
        content:
          application/json:
            schema:
              description: Individual Routing
              $ref: '#/components/schemas/RoutingDTO'
      responses:
        '200':
          description: Updated Routing
          content:
            application/json:
              schema:
                description: Individual Routing
                $ref: '#/components/schemas/RoutingDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
components:
  schemas:
    RoutingDTOListDTO:
      type: object
      properties:
        page:
          type: integer
          description: Current page number of entities
          format: int32
        perPage:
          type: integer
          description: Number of entities requested for the current page
          format: int32
        order:
          type:
          - 'null'
          - string
          description: Ordering criteria used for the current page
        statusCode:
          type: integer
          description: HTTP StatusCode for the current result
          format: int32
        recordsTotal:
          type: integer
          description: Total number of entities available
          format: int32
        entities:
          type:
          - 'null'
          - array
          items:
            description: Individual Routing
            $ref: '#/components/schemas/RoutingDTO'
          description: Page of entities for this request
      additionalProperties: false
    RoutingPatchDTO:
      type: object
      properties:
        name:
          maxLength: 128
          type:
          - 'null'
          - string
          description: New Name for the identified entity
        description:
          type:
          - 'null'
          - string
          description: New Description for the identified entity
        isActive:
          type:
          - 'null'
          - boolean
          description: New Status for the identified entity
          format: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
          description: New Tags for the identified entity
      additionalProperties: false
      description: Patch request for an individual Routing
    RoutingDTO:
      required:
      - isActive
      - name
      - proxyUrl
      - resourceSetId
      type: object
      properties:
        externalId:
          type: string
          format: uuid
        name:
          maxLength: 128
          minLength: 1
          type: string
          description: Name of the Entity
        description:
          type:
          - 'null'
          - string
          description: Description of the Entity
        isActive:
          type: boolean
          description: True/False value that determines if this entity is Active or Disabled
          format: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type:
          - 'null'
          - string
          format: date-time
        createdBy:
          type:
          - 'null'
          - string
        modifiedBy:
          type:
          - 'null'
          - string
        resourceSetId:
          type: string
          description: ID of the Resource Set related to routing
          format: uuid
        proxyUrl:
          maxLength: 255
          minLength: 1
          type: string
          description: URL of the proxy. The format is http(s)://server:port
      additionalProperties: false
      description: Individual Routing
    TagDTO:
      required:
      - key
      - value
      type: object
      properties:
        key:
          minLength: 1
          type: string
          description: Tag Key
        value:
          minLength: 1
          type: string
          description: Tag Key Value
      additionalProperties: false
      description: Aembit Entity Tag Details
    GenericResponseDTO:
      type: object
      properties:
        success:
          type: boolean
          description: True if the API call was successful, False otherwise
        message:
          type:
          - 'null'
          - string
          description: Message to indicate why the API call failed
        id:
          type: integer
          description: Unique identifier of the API response
          format: int32
      additionalProperties: false
      description: DTO for a Generic API Response
  securitySchemes:
    bearerAuth:
      type: http
      description: Authorization header using the Bearer scheme.
      scheme: bearer
      bearerFormat: Reference