---
title: "Create External API"
method: POST
path: "/ExternalApis"
tags: ["Externalapis"]
---

# Create External API

`POST /ExternalApis`

**Requires permission:** *IT*

Add a grantable external API endpoint (path prefix) to the catalogue.

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Request body

- PostExternalApiRequest
  - `externalApi` ExternalApi
    - `externalApiId` string, guid
    - `path` string, nullable
    - `displayName` string, nullable
    - `description` string, nullable
    - `active` boolean

## Response `200`

Success - External API created

- PostExternalApiResponse
  - `externalApi` ExternalApi
    - `externalApiId` string, guid
    - `path` string, nullable
    - `displayName` string, nullable
    - `description` string, nullable
    - `active` boolean
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Could not create External API
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/fab57bf5558a/schema)