# API List

<mark style="color:green;">**Path: API Management > API List**</mark>

All APIs on the system are listed here. You can view API details, test APIs, and configure whether registered or designed APIs are enabled.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fbg6VbJpCio0A48brenmX%2Fimage.png?alt=media&#x26;token=729eeda0-8602-427c-86cb-9cce71026117" alt=""><figcaption></figcaption></figure>

### Import APIs <a href="#toc169186074" id="toc169186074"></a>

In this section, you can find instructions on how to import registered/combined APIs.

1. Click **Import API** first to access the import page, click on the <img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/vDmPXKri4zUHafMoMa3N/1.png" alt="" data-size="line"> icon and upload the API to import.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FMYLqFbDRqjAyVAs8HTMb%2Fimage.png?alt=media&#x26;token=f57f4f4f-0018-4871-8119-ad3a490b7d2b" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FDbEtCTh7WjJBYAeOHhVx%2Fimage.png?alt=media&#x26;token=07ff53de-dada-492f-8f0a-68448833b74a" alt=""><figcaption></figcaption></figure>

2. Select a single JSON file to upload at a time, and click **Upload**.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fg1Bq8Y1vvDzytrlCxOXf%2Fimage.png?alt=media&#x26;token=ea9e8c02-d70f-48cc-95a5-4b8ef2166190" alt=""><figcaption></figcaption></figure>

3. The uploaded APIs will be displayed in the table below. Check to select the APIs for import, and click **Import** to upload them to the system.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F5pP9a2rhLs3Gu1Ln7NX9%2Fimage.png?alt=media&#x26;token=61dc693a-25cc-4a6e-9fe7-cdb5b2510f25" alt=""><figcaption></figcaption></figure>

### Search APIs <a href="#toc169186075" id="toc169186075"></a>

In this section, you can find instructions on how to search for APIs.

#### Keyword Search

Under the **Keyword Search** tab, enter the keyword and click **Search** to search for desired APIs.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FfZbeg6s0MFhtKVIPmGKR%2Fimage.png?alt=media&#x26;token=c295ebd5-3e06-4dee-8bcf-ba7663d041e4" alt=""><figcaption></figcaption></figure>

#### Search By Label

The Search By label feature is independent, and will not be affected by the basic keyword search or API sources.

1. Click the **Search By Label** tab.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FHUEHiM7Mz9DaFzvKHJGB%2Fimage.png?alt=media&#x26;token=d05c6be2-d6c6-4a64-8098-2fda17c99f42" alt=""><figcaption></figcaption></figure>

2. Enter the keyword in the **Label** field, check to select the desired labels from the suggestions, and click **Search** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FpKg1Xk68HVIs5ezI5xeL%2Fimage.png?alt=media&#x26;token=7a5d2e0c-9fe3-4e94-8399-83e22562e961" alt=""><figcaption></figcaption></figure>

3. The APIs match the label will be displayed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FtN9yIh1Pxll85qJyAEhv%2Fimage.png?alt=media&#x26;token=c7343f52-4afe-4b6d-85d0-dc72b2bf1e07" alt=""><figcaption></figcaption></figure>

### Switch View Modes

In this section, you can find instructions on how to view APIs using **Manage View**, **API Properties View**, and **Audit View**. The default mode is **Manage View**.

#### Manage View

**Manage View** displays API attributes for managing purposes.

1. Click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/TyByrz4YiyLxjpVuWbjD/image.png) icon.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FckgYbBXll9STYI97mdkE%2Fimage.png?alt=media&#x26;token=cb6029e2-885b-4002-b602-67dba2ded80b" alt=""><figcaption></figcaption></figure>

2. Select **Manage View**, and the icon changes to ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/J51VPZLQpcWgdjzzB9tL/image.png).

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FC2O11ExphIvTdpjhNwSH%2Fimage.png?alt=media&#x26;token=5f024e4b-b9cc-4ac1-803f-027523ee10f7" alt=""><figcaption></figcaption></figure>

3. View the API in **Manage View**.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FhIa0SDPGrcdmdQjIE0h7%2Fimage.png?alt=media&#x26;token=4408bd20-8f16-4b1e-980e-4a881d7e86dd" alt=""><figcaption></figcaption></figure>

#### API Properties View

**API Properties View** displays API attributes, including whether Cache is enabled and which Cache type is applied.

1. Click on the <img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FAviBdk2DKRferIcQExvE%2Fimage.png?alt=media&#x26;token=f5dbeffa-e5fe-44d1-9b2b-e6fad20852b8" alt="" data-size="original">icon.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FtzkUaCTfJakN5iPraZLf%2Fimage.png?alt=media&#x26;token=9e556416-b64f-42d5-8fc3-ac7684cfb90a" alt=""><figcaption></figcaption></figure>

2\. Select **API Properties View**, and the icon changes to ![](https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FnXVCaq64CvsswehZMKBD%2Fimage.png?alt=media\&token=caf6a6e4-da4d-4602-8caa-7591e495c4a5).

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F3Tz4u1WIMKob6RywgOGK%2Fimage.png?alt=media&#x26;token=b9b40b9f-ada5-4860-b42c-4cc63d295688" alt=""><figcaption></figcaption></figure>

3\. View the API in **API Properties View**.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FxRdH3rHVSqLM8EGErZ0y%2Fimage.png?alt=media&#x26;token=58301d8c-1a96-432a-8c72-ba4886d6eeef" alt=""><figcaption></figcaption></figure>

#### Audit Mode

**Audit View** displays API audit details, including the creator, creation time, last updated user, and last updated time for auditing purposes.

1. Click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/NXpqUxHlskr5qImVqpHc/image.png) icon.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FlrmAdGDtZC0Tr0yBDlEs%2Fimage.png?alt=media&#x26;token=b1b06ec2-c704-43a1-9188-ec338285621b" alt=""><figcaption></figcaption></figure>

2. Select **Audit View**, and the icon changes to ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/83PLjjhXSBofVBY3NMho/image.png).

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FCJ6VKMjU2OHfY436Kj6o%2Fimage.png?alt=media&#x26;token=1566cd66-856c-4ef0-9f76-bbf35d1ff37a" alt=""><figcaption></figcaption></figure>

3. View the API in **Audit View**.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/USNFEzeazBGIpUpRbSNH/image.png" alt=""><figcaption></figcaption></figure>

### View APIs <a href="#toc169186076" id="toc169186076"></a>

Search for the API to view details, and click on the![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/sEnVQvTld5KvKgPHn0l2/9.png)icon to access the API details page.

{% hint style="warning" %}
The information in **Details** is view-only.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/nc9NEjQ8oAazMaiId09l/image.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F6zJdhRyTdYgMCgsdnR22%2Fimage.png?alt=media&#x26;token=ee5c360b-f526-4b69-9760-f3b57e86697d" alt=""><figcaption></figcaption></figure>

### Test APIs <a href="#toc169186078" id="toc169186078"></a>

In this section, you can find instructions on how to test APIs.

1. Search for the API to test, and click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/Zx3EanzPS18eVbvZaGbI/19.png) icon to access the **API Test** page.

{% hint style="warning" %}
The API status must be enabled.
{% endhint %}

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FD0QpA8diZTSRLZq4NRl5%2Fimage.png?alt=media&#x26;token=40531bab-b488-4d35-8839-7a516298c18f" alt=""><figcaption></figcaption></figure>

2. Confirm the **digiRunner URL** and **Http Methods** fields, select the **Authorization** test method, and click **Test** to test whether this API can be used.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FIIPHwQ5aaHlwVgZd9L4I%2Fimage.png?alt=media&#x26;token=e10fe972-1c67-4eb4-b699-3471e4dece70" alt=""><figcaption></figcaption></figure>

3. If the result is Status *200* and there were data in Headers and Body, it means that this API is normal and can be used.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FlOPstdZdyUKARoexxy9O%2Fimage.png?alt=media&#x26;token=43f9214c-19ea-460e-84e6-9b2d7899ee51" alt=""><figcaption></figcaption></figure>

### Enable/Disable APIs

The APIs registered in the system are disabled (![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/xGCRydRYufJTOccZYyef/image.png)) by default, and must be manually enabled before use.

#### Enable/Disable APIs Immediately

1. Search for and check the APIs to enable, and click **Enable** to bring up the **Scheduled Enablement** dialog.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FhiZcCP0mKps8GpIhyNjb%2Fimage.png?alt=media&#x26;token=7ef3b944-67b0-4312-9c77-97de43f27125" alt=""><figcaption></figcaption></figure>

2. Ensure **API status** is set to **Enable**, leave the date input box blank, and click **Confirm** to activate the API immediately. Once activated, the API status will change to ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/qyZSYLrhlqpTFOfqoyrk/image.png).

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fp2QR30ALN3BHvItgfFpD%2Fimage.png?alt=media&#x26;token=8a8a3ed6-2751-4eaf-acc8-0d3a1017c349" alt=""><figcaption></figcaption></figure></div>

3. Search for and check the APIs to disable, and click **Disable** to bring up the **Scheduled Disablement** dialog.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FGEHlU1H2yhofgmSiRET4%2Fimage.png?alt=media&#x26;token=7880888f-4512-4ac2-bc0c-36b32eb3fcae" alt=""><figcaption></figcaption></figure>

4. Ensure **API status** is set to **Disable**, leave the date input box blank, and click **Confirm** to deactivate the API immediately. Once deactivated, the API status will change to ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/fycMSpa2xPFZPlO5x8V5/image.png).

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fo9mpJPPyeqs1KOMw7dcP%2Fimage.png?alt=media&#x26;token=70e27ca4-0bbf-45c7-9bbe-13dc01dc84d6" alt=""><figcaption></figcaption></figure></div>

#### Enable/Disable APIs on Schedule

1. Search for and check the APIs to schedule for enabling, and click **Enable** to bring up the **Scheduled Enablement** dialog.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FbVyPRLxmPjkOFQPzFHci%2Fimage.png?alt=media&#x26;token=4fbdd2ca-3df6-4132-bf49-49fafd5f3697" alt=""><figcaption></figcaption></figure>

2. Ensure **API status** is set to **Enable**, select the scheduled date, and click **Confirm** to schedule the API enablement.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FP9HiEL9GN2fVYtGvL2r2%2Fimage.png?alt=media&#x26;token=269312fd-9840-45f6-9e3e-3ee32926fc46" alt=""><figcaption></figcaption></figure></div>

3. The configured API will be enabled on the scheduled date.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FLkwgMsxmBoqpDuaDy2Kn%2Fimage.png?alt=media&#x26;token=ed88d5bc-1bba-41b2-b1ba-a15393c7980b" alt=""><figcaption></figcaption></figure>

4. To schedule a disablement date, check the desired APIs and click **Disable** to bring up the **Scheduled Disablement** dialog.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FqjSutLrsf0uSoWer4GR0%2Fimage.png?alt=media&#x26;token=f671c4d0-79de-4128-acf6-b757bd984169" alt=""><figcaption></figcaption></figure>

5. Set **API status** to **Disable**, select the scheduled date, and click **Confirm** to schedule the API disablement.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FkBWD8JUllOFkA11yKSi8%2Fimage.png?alt=media&#x26;token=c0080600-0099-4b91-a5b3-43329525de0d" alt=""><figcaption></figcaption></figure></div>

6. The configured API will be disabled on the scheduled date.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F8mOfAiKVE0J2xYaSglr7%2Fimage.png?alt=media&#x26;token=2b8a2083-2e51-4b3a-89f7-e4c95375076b" alt=""><figcaption></figcaption></figure>

#### Both Enable and Disable APIs on Schedule

You can schedule both the enablement and disablement of the same API. The steps required depend on the API’s current status.

1. For an API that is currently enabled, you must first set a disablement date before scheduling an enablement date.

   * Click **Disable** to bring up the **Scheduled Disablement** dialog.

   <figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FU4aShvFXE5x5RHPIGX6f%2Fimage.png?alt=media&#x26;token=eeb2b13a-46b7-4111-9343-3f0341128325" alt=""><figcaption></figcaption></figure>

   * Ensure **API status** is set to **Disable**, select the scheduled date, and click **Confirm** to schedule the API disablement.

   <div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FWktsJ0fdPoBwm11mdCqb%2Fimage.png?alt=media&#x26;token=4054b5b8-7198-4423-9883-a4bb731fd717" alt=""><figcaption></figcaption></figure></div>

   * Next, click **Enable** to bring up the **Scheduled Enablement** dialog.

   <figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FcaENLxe3YhXqet3Lqw3i%2Fimage.png?alt=media&#x26;token=4f573e07-25f0-48f5-b152-17673884cfb5" alt=""><figcaption></figcaption></figure>

   * Ensure **API status** is set to **Enable**, select the scheduled date, and click **Confirm** to schedule the API enablement.

   <div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FbutsFsJihwmr67w32S9C%2Fimage.png?alt=media&#x26;token=e9e3d33a-d6cd-4427-a4e3-97d7a0496fef" alt=""><figcaption></figcaption></figure></div>

   * Once configured, the scheduled enablement and disablement dates will be displayed in the corresponding columns in the API list.

   <figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F9kVd8hIt4LixLcKp2ve5%2Fimage.png?alt=media&#x26;token=33d93f5d-d390-4741-93c1-969ed20253f7" alt=""><figcaption></figcaption></figure>

2. For an API that is currently disabled, you must first set an enablement date before scheduling a disablement date.

   * Click **Enable** to bring up the **Scheduled Enablement** dialog.

   <figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FbXo7LTfneA0KSDLcaW0c%2Fimage.png?alt=media&#x26;token=394aa344-5460-4564-8558-0aef6b040cc1" alt=""><figcaption></figcaption></figure>

   * Ensure **API status** is set to **Enable**, select the scheduled date, and click **Confirm** to schedule the API disablement.

   <div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FgI5O7H8z0D7ETk8j1vVG%2Fimage.png?alt=media&#x26;token=03bd53cb-8556-4d5b-a004-432d5c35b28b" alt=""><figcaption></figcaption></figure></div>

   * Next, click **Disable** to bring up the **Scheduled Disablement** dialog.

   <figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FhhebmiP00KAox5F89lm4%2Fimage.png?alt=media&#x26;token=498d650f-0e6d-44fe-9bdc-284c9a179991" alt=""><figcaption></figcaption></figure>

   * Ensure **API status** is set to **Disable**, select the scheduled date, and click **Confirm** to schedule the API enablement.

   <div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FhsvSjrLRxi3nYzQfsefz%2Fimage.png?alt=media&#x26;token=0a2c22d0-2067-4527-99d0-4a6761f6bb1e" alt=""><figcaption></figcaption></figure></div>

   * Once configured, the scheduled enablement and disablement dates will be displayed in the corresponding columns in the API list.

   <figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Ft2QQrpmcKQN7EAoGoRUa%2Fimage.png?alt=media&#x26;token=a580e809-d7ba-4e03-90e8-f26fb4308c31" alt=""><figcaption></figcaption></figure>

#### Cancel Schedules

1. Search for and check the APIs to cancel the scheduled enablement, and click **Cancel Scheduled Date** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F9A5fkgwHLqQVnIfRGX9u%2Fimage.png?alt=media&#x26;token=73c6dae9-2314-49f0-b8e7-805c342c2948" alt=""><figcaption></figcaption></figure>

2. Set **API status** to **Cancel Scheduled Enablement**, and click **Confirm** to cancel scheduled enablement.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fq4KqI9WXz4bkMkiF1UPY%2Fimage.png?alt=media&#x26;token=ff518d4d-e2d5-4541-bd8c-da407ca2f58d" alt=""><figcaption></figcaption></figure></div>

3. The scheduled API enablement has been canceled.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FnktwEKQCltIBeRXEhzIz%2Fimage.png?alt=media&#x26;token=77597dc7-58d9-4527-8422-cc82f8606c9c" alt=""><figcaption></figcaption></figure>

4. Search for and check the APIs to cancel the scheduled disablement, and click **Cancel Scheduled Date** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FyOQT0v38ZaFfZs9MMKqT%2Fimage.png?alt=media&#x26;token=acc05e77-1343-4983-a72c-7a06b4ebb5ae" alt=""><figcaption></figcaption></figure>

5. Set **API status** to **Cancel Scheduled Disablement**, and click **Confirm** to cancel scheduled disablement.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FHWkd8bPKDcvvyMz5U2s3%2Fimage.png?alt=media&#x26;token=2fd76902-7e71-48ff-b586-fa62805b64e5" alt=""><figcaption></figcaption></figure></div>

6. The scheduled API disablement has been canceled.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FNrsPxg2b3JcMgLK0IIUD%2Fimage.png?alt=media&#x26;token=c76e4a97-51e1-4dd0-b8d1-6961658cf7e3" alt=""><figcaption></figcaption></figure>

7. Search for and check the APIs to cancel the scheduled enablement and disablement, and click **Cancel Scheduled Date** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F62FqXvgnr1ktiRXYsGXi%2Fimage.png?alt=media&#x26;token=eb59cec4-bb5e-4c96-a98e-b9ef8da838eb" alt=""><figcaption></figcaption></figure>

8. Set **API status** to **Cancel Both Schedules**, and click **Confirm** to cancel scheduled enablement and disablement.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F9cHSX1hA5gvsRo3O8Iam%2Fimage.png?alt=media&#x26;token=291fe8b4-72eb-4365-b5f3-9e01a14b5a41" alt=""><figcaption></figcaption></figure></div>

9. The scheduled API enablement and disablement have been canceled.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FLUnKVSOFQwGRXBQTWK8I%2Fimage.png?alt=media&#x26;token=77949f88-2878-4ee5-a6c0-4ca3424ee29d" alt=""><figcaption></figcaption></figure>

### Delete APIs <a href="#toc169186080" id="toc169186080"></a>

In this section, you can find instructions on how to delete APIs.

1. Search for the API to delete, and click **Delete** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F1oeNt3xrnNqM4mrUyXpQ%2Fimage.png?alt=media&#x26;token=ca3e5c1a-8abd-489d-9405-a2b67ff35b7f" alt=""><figcaption></figcaption></figure>

2. A warning prompt displaying the message “**Confirm Delete?**” will pop up. Click **Confirm** to delete this API and exit.

{% hint style="warning" %}
The API you want to delete must be disabled and not applied by groups.
{% endhint %}

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FaZbI0UIEAPdS0cCkhPCn%2Fimage.png?alt=media&#x26;token=9ce939ee-59f3-4d72-8caf-87b331e47c12" alt=""><figcaption></figcaption></figure></div>

### JWT Settings

The system supports JWT encryption for APIs, including both **JWS** (JSON Web Signature) and **JWE** (JSON Web Encryption). For both the **Request** (incoming) and **Response** (outgoing), you can configure the use of either JWS (signature) or JWE (encryption).

* **JWT**: A standard format for securely transmitting information over networks. It can be signed using **JWS** or encrypted using **JWE**.
* **JWS**: Applies a digital signature to ensure data integrity during transmission.
* **JWE**: Fully encrypts the JWT payload to protect its contents from being read by third parties during transmission.

1. In the **Enterprise** edition, the system allows batch configuration of JWT settings. Select the APIs to configure and click **JWT Settings**.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2Fkn9RDV2J4gqWachkLRSS%2Fimage.png?alt=media&#x26;token=00595c6e-62d9-40e0-b481-1b2c8bb98fc3" alt=""><figcaption></figcaption></figure>

2. If **Body Encode** is enabled (**Y**), you can set the Request and Response of the API to use **JWT**, **JWE**, or **Do not use**.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FpoqZSj7SkOdHpGA8lAW1%2Fimage.png?alt=media&#x26;token=e2308e31-a1af-4c4e-aae6-bfbfee25807b" alt=""><figcaption></figcaption></figure></div>

3. If **Body Encode** is disabled (**N**), you can disable JWT for the selected APIs.

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F31CswqDmL4smoFXLxkFc%2Fimage.png?alt=media&#x26;token=218a0bd1-81b9-4a6b-8e3a-f491457a08df" alt=""><figcaption></figcaption></figure></div>

4. Whether JWS or JWE was selected for the **Request**, the background color is **light orange** ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/nSw7wfG7N2bestUkcSd2/image.png); for the Response, the background color is **light blue** ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/CRcW6O5lD0mVkb2MLiMX/image.png).

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FDORrIBX7Z8rz9DTt8Huk%2Fimage.png?alt=media&#x26;token=88afe931-6f6d-420f-ae56-f7b2ce01eed9" alt=""><figcaption></figcaption></figure>

<div align="left"><figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FGqvdl5HtKBqA86fkEaQL%2Fimage.png?alt=media&#x26;token=76448e54-ffba-4832-ba9e-3014527efd6b" alt=""><figcaption></figcaption></figure></div>

### Configure Organization

In this section, you can find instructions on how to configure the organization for APIs.

1. Search for the API to update the organization, and click **Configure Organization** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FGK0Nc93U8UXyLAcBEqf5%2Fimage.png?alt=media&#x26;token=9e037440-292c-462e-bf90-766ecd519a4d" alt=""><figcaption></figcaption></figure>

2. Select the organization to assign to the API, and click **Confirm** to save and exit.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2FsYNQSOATJ5XC0NuLyj3C%2Fimage.png?alt=media&#x26;token=ffffb9f8-a79f-4742-bafc-905d31262f3b" alt=""><figcaption></figcaption></figure>

### Export APIs

1. To export registered and combined APIs, search for the API to export, and click **Export** to proceed.

<figure><img src="https://3495903199-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0choIC1BbdPOkKWOYGgk%2Fuploads%2F5gZr9LQ10cJP00MuItaa%2Fimage.png?alt=media&#x26;token=da82dcbd-a12d-4d46-af8b-aa96e80c4a0a" alt=""><figcaption></figcaption></figure>

2. A warning prompt displaying the message “**Confirm Export?**” will pop up. Click **Confirm** to download the json file.

{% hint style="warning" %}
APIs with JAVA and .NET as sources cannot be exported.
{% endhint %}

<div align="left"><figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/LudnxfbcwMEmkHRy5xTC/image.png" alt="" width="563"><figcaption></figcaption></figure></div>

### Swagger

1. Click on the<img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/pZPiaeGHf50JTpd9zAF0/image.png" alt="" data-size="line">icon to access the Swagger page.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/JKwH5DtZiq7HPhJx8GZa/image.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/xBASCjcPqotht9czaYZ6/image.png" alt=""><figcaption></figcaption></figure>

2. Copy the text on the Swagger page to [Swagger.io](https://editor.swagger.io/) to display its information.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/qk3Tvoeh8Nq4LUfX6OKQ/image.png" alt=""><figcaption></figcaption></figure>