Aux Data API
Endpoint Index
Action | Endpoint |
---|---|
Fetch Aux Data Keys for a Locator | GET /auxdata/{tenantLocator}/auxdata/{locator} |
Fetch Aux Data | GET /auxdata/{tenantLocator}/auxdata/{locator}/{key} |
Add Aux Data | PUT /auxdata/{tenantLocator}/auxdata/{locator} |
Delete Aux Data | DELETE /auxdata/{tenantLocator}/auxdata/{locator}/{key} |
Get the Size of Aux Data for a Tenant | GET /auxdata/{tenantLocator}/auxdata/size |
GET /auxdata/{tenantLocator}/auxdata/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
offset | query | int? | optional |
count | query | int? | optional |
Response:AuxDataKeySetResponse
Security Group:auxdata  Permissions:read,list
AuxDataKeySetResponse
¶requiredcount intoffset intkeys AuxDataKey[]
AuxDataKey
¶requiredkey stringuiType Enum normal | hidden | readonlyoptionalauxDataSettingsName string?
GET /auxdata/{tenantLocator}/auxdata/{locator}/{key}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
key | path | string | required |
Response:AuxDataResponse
Security Group:auxdata  Permission:read
AuxDataResponse
¶requiredlocator stringkey stringmodificationTimestamp datetimeuiType Enum normal | hidden | readonlyvalue stringoptionalauxDataSettingsName string?expirationTimestamp datetime?
PUT /auxdata/{tenantLocator}/auxdata/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:AuxDataSetCreateRequest
Response:void
Security Group:auxdata  Permission:write
AuxDataSetCreateRequest
¶requiredauxData AuxDataSet[]optionalauxDataSettingsName string?
AuxDataSet
¶requiredkey stringuiType Enum normal | hidden | readonlyvalue string
DELETE /auxdata/{tenantLocator}/auxdata/{locator}/{key}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
key | path | string | required |
Response:void
Security Group:auxdata  Permission:write
GET /auxdata/{tenantLocator}/auxdata/size
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Response:AuxDataSizeResponse
Security Group:auxdata  Permission:read
AuxDataSizeResponse
¶requireddataSizeKb int