Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Data Delivery/ Obtaining the Delivery Authorization List

Updated on 2025-12-18 GMT+08:00

CLI Examples

View PDF

Obtaining the Delivery Authorization List

This API is used to obtain the delivery authorization list.

For details, see Calling APIs.

GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers/authorizations

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
source_region	No	String	Data source.
destination_shipper_type	No	String	Destination delivery type.
shipper_status	No	String	Data delivery status.
auth_status	No	String	Attachment status.
limit	No	Long	Number of records on each page.
offset	No	Long	Page number.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	Integer	Error code. The value 0 indicates a success. Other values indicate an error.
data	data object	Result data.
msg	String	Returned status information, which describes the result of the current request.

**Table 5** data
Parameter	Type	Description
data	Array of data objects	Result data.
limit	Integer	Number of records displayed on each page.
offset	Integer	Start offset of the current page.
total	Integer	Total number of records.

**Table 6** data
Parameter	Type	Description
authorize_status	Integer	Authorization status. 0: Authorized; 1: Unauthorized; and 2: Rejected.
data_source_query	String	Data source query string, which indicates the data source path.
data_type	Integer	Data type. It is defined based on services.
dataspace	String	Data space ID, which is unique.
id	Integer	Unique ID.
pipe	String	Pipeline ID, which is unique.
region	String	Region information.
request_time	Long	Request time, which is a timestamp in milliseconds.
handler_time	Long	Authorization time, which is a timestamp in milliseconds.
run_status	Integer	Running status. The specific meaning depends on the service definition.
shipper_id	String	Shipping ID, which is unique.
shipper_name	String	Shipping name.
workspace	String	Workspace ID, which uniquely identifies a workspace.