Skip to main content

View Gateway Endpoint details

The Gateway Endpoint tab lists every domain that clients can use to call an API Gateway, including the default domain that the system assigns and the Custom Domains you add. Here you can check which domains are active and whether the Certificate of each domain is still valid.

Step 1Open the Gateway Endpoint tab of the API Gateway
1 / 2
Step 1: Open the Gateway Endpoint tab of the API Gateway

Click the image to zoom in.

View Gateway Endpoint details​

  1. In the left menu, select API Gateway → Gateway, click the API Gateway name, then select the Gateway Endpoint tab.

Gateway Endpoint tab with the default domain and the Custom Domains

The list has the following columns:

ColumnDescription
Domain nameDomain name. Click the name to open https://<domain> in a new tab, or click the copy icon to copy the domain.
StatusStatus of the domain, see the status table below.
DescriptionDescription of the Custom Domain. Shows - when empty.
Created BySYS for the default domain, the person who added the domain for a Custom Domain.
Created AtWhen the domain was added. For the default domain, when the API Gateway was created.
⋮Action menu, only on Custom Domain rows. See the action table below.

The Status column has the following statuses:

StatusMeaning
AvailableDefault domain. The system manages its Certificate.
Cert validThe Custom Domain has a valid Certificate.
Cert expiredThe Certificate of the Custom Domain has expired. Renew the Certificate or switch to another Certificate.
note

The system does not check DNS. The Cert valid status does not mean the domain already points to the API Gateway, see Verify the Custom Domain.

The toolbar has the Search box to search by domain, the Add Domain button to add a Custom Domain, and the Column button to choose, hide, and order the columns.

The ⋮ menu at the end of each Custom Domain row has 2 actions:

ActionDescription
EditChange the Certificate of the Custom Domain. See Edit a Custom Domain.
DeleteDelete the Custom Domain. See Delete a Custom Domain. Disabled when it is the only endpoint of the API Gateway.

Action menu of a Custom Domain

A Custom Domain also appears in the Gateway URL column of the API Gateway list (as https://<domain>) and in the SNIs and Used by columns of the Certificate.

Next steps​

Last updated on