Public Resource

List resources for an organization.

get/org/{orgId}/public-resources

Request

  • Base URL: https://api.pangolin.net/v1
  • URL: https://api.pangolin.net/v1/org/{orgId}/public-resources
  • Auth: HTTP bearer

Path parameters

orgIdstring required

Query parameters

pageSizeinteger

Number of items per page

pageinteger

Page number to retrieve

querystring
sort_by'name'

Field to sort by

order'asc' | 'desc'

Sort order

enabledboolean

Filter resources based on enabled status

authState'protected' | 'not_protected' | 'none'

Filter resources based on authentication state. protected means the resource has at least one auth mechanism (password, pincode, header auth, SSO, or email whitelist). not_protected means the resource has no auth mechanisms. none means the resource is not protected by HTTP (i.e. it has no auth mechanisms and http is false).

healthStatus'healthy' | 'degraded' | 'offline' | 'unknown'

Filter resources based on health status of their targets. healthy means all targets are healthy. degraded means at least one target is unhealthy, but not all are unhealthy. offline means all targets are unhealthy. unknown means all targets have unknown health status.

protocol'http' | 'https' | 'tcp' | 'udp' | 'ssh' | 'rdp' | 'vnc' | 'inference'

Filter resources by protocol. http and https match HTTP resources without and with SSL respectively.

siteIdinteger

When set, only resources that have at least one target on this site are returned

status'pending' | 'approved'

Filter by resource status

unknown

Response

Successful response

dataobject nullable required
successboolean required
errorboolean required
messagestring required
statusnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.