resources.proxyConfiguration

GET

/resources/{resourceId}/proxy-configuration

const url = 'https://example.com/api/resources/example/proxy-configuration?routeScope=planned&includeDiagnostics=false';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/resources/example/proxy-configuration?routeScope=planned&includeDiagnostics=false'

Previews generated proxy configuration for a resource. Public docs: /docs/resources/profiles/health-network/#resource-network-profile

Parameters

Path Parameters

resourceId

required

string

>= 1 characters

Query Parameters

deploymentId

string

>= 1 characters

routeScope

string

default: latest

Allowed values: planned latest deployment-snapshot

includeDiagnostics

boolean

Responses

200

application/json

object

resourceId

required

string

deploymentId

string

providerKey

required

string

routeScope

required

string

Allowed values: planned latest deployment-snapshot

status

required

string

Allowed values: not-configured planned applied stale failed

generatedAt

required

string

lastAppliedDeploymentId

string

stale

required

boolean

routes

required

Array<object>

object

hostname

required

string

scheme

required

string

Allowed values: http https

url

required

string

pathPrefix

required

string

tlsMode

required

string

Allowed values: auto disabled

targetPort

integer

> 0 <= 9007199254740991

source

required

string

Allowed values: generated-default domain-binding deployment-snapshot server-applied

routeBehavior

string

Allowed values: serve redirect

redirectTo

string

redirectStatus

Any of:

number

Allowed value: 301

sections

required

Array<object>

object

required

string

title

required

string

format

required

string

Allowed values: docker-labels file command yaml json text

language

string

readonly

required

boolean

redacted

required

boolean

content

required

string

source

required

string

Allowed values: provider-rendered snapshot diagnostic

warnings

required

Array<object>

object

code

required

string

message

required

string

details

object

key

additional properties

Any of:

string

diagnostics

object

providerKey

required

string

routeCount

required

number

networkName

string

tlsRoutes

Array<object>

object

hostname

required

string

pathPrefix

required

string

tlsMode

required

string

Allowed values: auto disabled

scheme

required

string

Allowed values: http https

automation

required

string

Allowed values: disabled provider-local

certificateSource

required

string

Allowed values: none provider-local

appaloftCertificateManaged

required

boolean

message

required

string

details

object

key

additional properties

string

metadata

object

key

additional properties

string

Example

{
  "routeScope": "planned",
  "status": "not-configured",
  "routes": [
    {
      "scheme": "http",
      "tlsMode": "auto",
      "source": "generated-default",
      "routeBehavior": "serve",
      "redirectStatus": 301
    }
  ],
  "sections": [
    {
      "format": "docker-labels",
      "readonly": true,
      "source": "provider-rendered"
    }
  ],
  "diagnostics": {
    "tlsRoutes": [
      {
        "tlsMode": "auto",
        "scheme": "http",
        "automation": "disabled",
        "certificateSource": "none"
      }
    ]
  }
}