resources.list

GET

/resources

curl --request GET \
  --url https://example.com/api/resources

Parameters

Query Parameters

projectId

string

environmentId

string

Responses

200

OK

Media type application/json

object

items

required

Array<object>

object

id

required

string

projectId

required

string

environmentId

required

string

destinationId

string

name

required

string

slug

required

string

kind

required

string

Allowed values: application service database cache compose-stack worker static-site external

description

string

createdAt

required

string

services

required

Array<object>

object

name

required

string

kind

required

string

Allowed values: web api worker database cache service

networkProfile

object

internalPort

required

integer

> 0 <= 9007199254740991

upstreamProtocol

required

string

default: http

Allowed values: http tcp

exposureMode

required

string

default: reverse-proxy

Allowed values: none reverse-proxy direct-port

targetServiceName

string

>= 1 characters

hostPort

integer

> 0 <= 9007199254740991

accessProfile

object

generatedAccessMode

required

string

default: inherit

Allowed values: inherit disabled

pathPrefix

required

string

default: / >= 1 characters

deploymentCount

required

number

lastDeploymentId

string

lastDeploymentStatus

string

Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back

accessSummary

object

plannedGeneratedAccessRoute

object

url

required

string

hostname

required

string

scheme

required

string

Allowed values: http https

providerKey

string

pathPrefix

required

string

proxyKind

required

string

Allowed values: none traefik caddy

targetPort

required

integer

> 0 <= 9007199254740991

latestGeneratedAccessRoute

object

url

required

string

hostname

required

string

scheme

required

string

Allowed values: http https

providerKey

string

deploymentId

required

string

deploymentStatus

required

string

Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back

pathPrefix

required

string

proxyKind

required

string

Allowed values: none traefik caddy

targetPort

integer

> 0 <= 9007199254740991

updatedAt

required

string

latestDurableDomainRoute

object

url

required

string

hostname

required

string

scheme

required

string

Allowed values: http https

providerKey

string

deploymentId

required

string

deploymentStatus

required

string

Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back

pathPrefix

required

string

proxyKind

required

string

Allowed values: none traefik caddy

targetPort

integer

> 0 <= 9007199254740991

updatedAt

required

string

latestServerAppliedDomainRoute

object

url

required

string

hostname

required

string

scheme

required

string

Allowed values: http https

providerKey

string

deploymentId

required

string

deploymentStatus

required

string

Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back

pathPrefix

required

string

proxyKind

required

string

Allowed values: none traefik caddy

targetPort

integer

> 0 <= 9007199254740991

updatedAt

required

string

proxyRouteStatus

string

Allowed values: unknown ready not-ready failed

lastRouteRealizationDeploymentId

string

Example

{
  "items": [
    {
      "kind": "application",
      "services": [
        {
          "kind": "web"
        }
      ],
      "networkProfile": {
        "upstreamProtocol": "http",
        "exposureMode": "none"
      },
      "accessProfile": {
        "generatedAccessMode": "inherit",
        "pathPrefix": "/"
      },
      "lastDeploymentStatus": "created",
      "accessSummary": {
        "plannedGeneratedAccessRoute": {
          "scheme": "http",
          "proxyKind": "none"
        },
        "latestGeneratedAccessRoute": {
          "scheme": "http",
          "deploymentStatus": "created",
          "proxyKind": "none"
        },
        "latestDurableDomainRoute": {
          "scheme": "http",
          "deploymentStatus": "created",
          "proxyKind": "none"
        },
        "latestServerAppliedDomainRoute": {
          "scheme": "http",
          "deploymentStatus": "created",
          "proxyKind": "none"
        },
        "proxyRouteStatus": "unknown"
      }
    }
  ]
}