Download custom resource

POST 
/api/sase/v1.0/resource/tenant/:tenant_id/download

Download a CSV file containing the results of a request for custom resources. The query for this information is created using Export Custom Resource.

Request

Path Parameters

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.

application/json

Body

required

The JSON request object

object

Responses

200

List of data objects

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 Resource Query request responses

1. Invalid Resource property name (Error code: DATA10002)
2. Invalid Resource request parameter (Error code: DATA10003)
3. The resource or property is not licensed (Error code: DATA10004)

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": "Resource property 'property1' is not valid",
  "errorCode": "DATA10002",
  "message": "Invalid Resource property name",
  "values": [
    "property1"
  ]
}

403

Permission response

1. Permission Denied (Error code: REST10003)

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": "Permission Denied",
  "errorCode": "REST10003",
  "message": "Permission Denied",
  "values": [
    "value1"
  ]
}

404

Resource not available response

1. Resource not found (Error code: REST10002)

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": "Resource not found",
  "errorCode": "REST10002",
  "message": "Resource not found",
  "values": [
    "value1"
  ]
}

500

Unexpected server error response

1. Unexpected server error (Error code: REST10001)

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": "Failed to process request",
  "errorCode": "REST10001",
  "message": "Unexpected server error",
  "values": [
    "value1"
  ]
}

Loading...