- URL:
- https://<root>/security/ingress
- Methods:
GET- Operations:
- Update Configuration
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The ingress resource returns the currently configured security information for the Ingress controller. You can update ingress security configuration properties using the Update operation. The update operation must be used when adding an imported wildcard certificate for the Ingress controller.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Response properties
| Property | Details |
|---|---|
| The cipher suites, in OpenSSL format, used by the Ingress controller. The cipher suites listed below, in both OpenSSL and Internet Assigned Numbers Authority (IANA) format, are configured by default and work for TLSv1.2 and TLSv1.3. If the TLS protocols TLSv1 or TLSv1.1 are specified in the
|
| A comma-separated list that specifies the TLS protocols the Ingress controller will support. |
| The name of a user-defined TLS secret that exists in the same namespace as ArcGIS Enterprise on Kubernetes, which contains the wildcard certificate that will be used by the Ingress controller. This property must be specified if |
| Specifies the identity wildcard certificate that will be used by the Ingress controller. The certificate must have already been imported and given an alias. The alias of the imported certificate will be passed as the value for this property. This property must be set if |
| A Boolean that indicates whether HTTP Strict Transport Security (HSTS) is enabled by the Ingress controller. Values: |
| Specifies where the identity certificate used by the Ingress controller is stored. If Values: |
Example usage
The following is a sample request URL used to access the ingress resource:
https://organization.example.com/<context>/admin/security/ingress?f=pjsonJSON Response example
{
"cipherSuites": "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-CHACHA20-POLY1305:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA",
"httpsProtocols": "TLSv1.2 TLSv1.3",
"tlsSecretName": "arcgis-ingress-cert",
"identityCertificateName": "ingress",
"hstsEnabled": false,
"isTlsSecretSystemManaged": true
}