Get resource details

GET 
/api/sase/v1.0/resource/tenant/:tenant_id/:resource_name

Returns all resource information, including available properties and details.

Request

Path Parameters

resource_name stringrequired

Name of the resource for which you want information. The supported resources are:

• site_current_status

  Provides connection status information.

• alerts

  Provides information on alerts raised by your tenant.

tenant_id stringrequired

Unique tenant ID.

Header Parameters

Prisma-SubTenant string

Sub-tenant ID. This parameter is required only if a sub-tenant is configured.

Responses

200

List of resources

application/json

Schema

Schema

data object[]
Response Data
Array [
empty boolean
]
header object
Response header
empty boolean

Example (from schema)

{
  "data": [
    {
      "average_property3": 10.75,
      "property1": "value1",
      "property2": 10
    },
    {
      "average_property3": 20.99,
      "property1": "value2",
      "property2": 25
    }
  ],
  "header": {
    "createdAt": "Fri Jan  1 00:00:00 PST 2021",
    "name": "Response Name",
    "requestId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

400

Invalid Request

application/json

Schema

Schema

details stringrequired

Error details

errorCode stringrequired

Error code

message stringrequired

Error Message

values object

Values in error details. Used to construct error in different language

Example (from schema)

{
  "details": "Input value 'property1' is not valid",
  "errorCode": "REST10001",
  "message": "Invalid input",
  "values": [
    "property1"
  ]
}

500

Unexpected server error

application/json

Schema

Schema

details stringrequired

Error details

errorCode stringrequired

Error code

message stringrequired

Error Message

values object

Values in error details. Used to construct error in different language

Example (from schema)

{
  "details": "Input value 'property1' is not valid",
  "errorCode": "REST10001",
  "message": "Invalid input",
  "values": [
    "property1"
  ]
}

Loading...