Skip to content
Appaloft 文档 v0.6.0

resources.show

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

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
resourceId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
includeLatestDeployment
Any of:
boolean
includeAccessSummary
Any of:
boolean
includeProfileDiagnostics
Any of:
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
schemaVersion
required
string
Allowed value: resources.show/v1
resource
required
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
deploymentCount
required
number
lastDeploymentId
string
lastDeploymentStatus
string
Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back
source
object
kind
required
string
Allowed values: local-folder local-git remote-git git-public git-github-app git-deploy-key zip-artifact dockerfile-inline docker-compose-inline docker-image compose
locator
required
string
displayName
required
string
gitRef
string
commitSha
string
baseDirectory
string
originalLocator
string
repositoryId
string
repositoryFullName
string
defaultBranch
string
imageName
string
imageTag
string
imageDigest
string
metadata
object
key
additional properties
string
runtimeProfile
object
strategy
required
string
Allowed values: auto dockerfile docker-compose prebuilt-image workspace-commands static
installCommand
string
buildCommand
string
startCommand
string
runtimeName
string
publishDirectory
string
dockerfilePath
string
dockerComposeFilePath
string
buildTarget
string
healthCheckPath
string
healthCheck
object
enabled
required
boolean
type
required
string
Allowed values: http command
intervalSeconds
required
integer
> 0 <= 9007199254740991
timeoutSeconds
required
integer
> 0 <= 9007199254740991
retries
required
integer
> 0 <= 9007199254740991
startPeriodSeconds
required
integer
<= 9007199254740991
http
object
method
required
string
Allowed values: GET HEAD POST OPTIONS
scheme
required
string
Allowed values: http https
host
required
string
port
integer
> 0 <= 65535
path
required
string
expectedStatusCode
required
integer
>= 100 <= 599
expectedResponseText
string
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
healthPolicy
object
enabled
required
boolean
type
required
string
Allowed values: http command
intervalSeconds
required
integer
> 0 <= 9007199254740991
timeoutSeconds
required
integer
> 0 <= 9007199254740991
retries
required
integer
> 0 <= 9007199254740991
startPeriodSeconds
required
integer
<= 9007199254740991
http
object
method
required
string
Allowed values: GET HEAD POST OPTIONS
scheme
required
string
Allowed values: http https
host
required
string
port
integer
> 0 <= 65535
path
required
string
expectedStatusCode
required
integer
>= 100 <= 599
expectedResponseText
string
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
latestDeployment
object
id
required
string
status
required
string
Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back
createdAt
required
string
startedAt
string
finishedAt
string
serverId
required
string
destinationId
required
string
lifecycle
required
object
status
required
string
Allowed values: active archived deleted
archivedAt
string
deletedAt
string
diagnostics
required
Array<object>
object
code
required
string
severity
required
string
Allowed values: info warning error
message
required
string
path
string
generatedAt
required
string
Example 
{
  "schemaVersion": "resources.show/v1",
  "resource": {
    "kind": "application",
    "services": [
      {
        "kind": "web"
      }
    ],
    "lastDeploymentStatus": "created"
  },
  "source": {
    "kind": "local-folder"
  },
  "runtimeProfile": {
    "strategy": "auto",
    "healthCheck": {
      "type": "http",
      "http": {
        "method": "GET",
        "scheme": "http"
      }
    }
  },
  "networkProfile": {
    "upstreamProtocol": "http",
    "exposureMode": "none"
  },
  "accessProfile": {
    "generatedAccessMode": "inherit",
    "pathPrefix": "/"
  },
  "healthPolicy": {
    "type": "http",
    "http": {
      "method": "GET",
      "scheme": "http"
    }
  },
  "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"
  },
  "latestDeployment": {
    "status": "created"
  },
  "lifecycle": {
    "status": "active"
  },
  "diagnostics": [
    {
      "severity": "info"
    }
  ]
}