# Aux Data API



<EndpointIndex
  names={[
  	'getAuxDataKeys',
  	'getAuxData',
  	'putAuxData',
  	'deleteAuxData',
  	'getAuxDataSize',
  ]}
  titles={{
  	getAuxDataKeys: 'Fetch Aux Data Keys for a Locator',
  	getAuxData: 'Fetch Aux Data',
  	putAuxData: 'Add Aux Data',
  	deleteAuxData: 'Delete Aux Data',
  	getAuxDataSize: 'Get the Size of Aux Data for a Tenant',
  }}
/>

Fetch Aux Data Keys for a Locator [#fetch-aux-data-keys-for-a-locator]

<ApiEndpoint name="getAuxDataKeys" title="Fetch Aux Data Keys for a Locator" />

<ApiSchema name="AuxDataKeySetResponse" />

<ApiSchema name="AuxDataKey" />

Fetch Aux Data [#fetch-aux-data]

<ApiEndpoint name="getAuxData" title="Fetch Aux Data" />

<ApiSchema name="AuxDataResponse" />

Add Aux Data [#add-aux-data]

<ApiEndpoint name="putAuxData" title="Add Aux Data" />

<ApiSchema name="AuxDataSetCreateRequest" />

<ApiSchema name="AuxDataSet" />

Delete Aux Data [#delete-aux-data]

<ApiEndpoint name="deleteAuxData" title="Delete Aux Data" />

Get the Size of Aux Data for a Tenant [#get-the-size-of-aux-data-for-a-tenant]

<ApiEndpoint name="getAuxDataSize" title="Get the Size of Aux Data for a Tenant" />

<ApiSchema name="AuxDataSizeResponse" />


## API Reference

GET /auxdata/{tenantLocator}/auxdata/{locator} — getAuxDataKeys
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  locator (string, path, required)
  offset (integer, query)
  count (integer, query)
Responses:
  200 AuxDataKeySetResponse — OK

GET /auxdata/{tenantLocator}/auxdata/{locator}/{key} — getAuxData
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (string, path, required)
  key (string, path, required)
Responses:
  200 AuxDataResponse — OK

PUT /auxdata/{tenantLocator}/auxdata/{locator} — putAuxData
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (string, path, required)
Request body (AuxDataSetCreateRequest):
Responses:
  200 — OK

DELETE /auxdata/{tenantLocator}/auxdata/{locator}/{key} — deleteAuxData
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (string, path, required)
  key (string, path, required)
Responses:
  200 — OK

GET /auxdata/{tenantLocator}/auxdata/size — getAuxDataSize
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
Responses:
  200 AuxDataSizeResponse — OK

AuxDataKeySetResponse
Properties:
  offset (integer, required)
  count (integer, required)
  keys (AuxDataKey[], required)

AuxDataKey
Properties:
  key (string, required)
  uiType (Enum normal | hidden | readonly, required)
  auxDataSettingsName (string)

AuxDataResponse
Properties:
  locator (string, required)
  key (string, required)
  uiType (Enum normal | hidden | readonly, required)
  value (string, required)
  modificationTimestamp (datetime, required)
  expirationTimestamp (datetime)
  auxDataSettingsName (string)

AuxDataSetCreateRequest
Properties:
  auxDataSettingsName (string)
  auxData (AuxDataSet[], required)

AuxDataSet
Properties:
  uiType (Enum normal | hidden | readonly, required)
  key (string, required)
  value (string, required)

AuxDataSizeResponse
Properties:
  dataSizeKb (integer, required)