跳到主要内容

Modify a Domain Authentication

Modify the token authentication for an ingest domain.

Request

Request-Line

PUT /lls/v1.0/domain/{domain}/authentication

Request Parameters

Path Parameters

ParameterTypeRequiredDescription
domainStringMandatoryDelivery domain name.

Body Parameters

ParameterTypeRequiredDescription
authenticationBooleanMandatoryEnable authentication or not.
authenticationTypeStringOptionalAuthentication type. Valid values: default, 3rdparty.
3rdPartyEndpointStringOptionalThird party endpoint for authentication

Response

Response Body

ParameterTypeRequiredDescription
domainStringMandatoryDomain name.
createdTimestampMandatoryTimestamp of created time in UTC timezone. Default is now.
authenticationBooleanMandatoryenable authentication or not.
authenticationTypeStringOptionalAuthentication type. Valid values: default, 3rdparty.
authenticationKeyStringOptionalAuthentication key for default authentication.
3rdPartyEndpointStringOptionalThird party endpoint for authentication

Status Codes, Error Codes and Error Messages

Status CodeError CodeError Message
400LLS.Domain.InvalidDomain name invalid.

Examples

Enable default authentication

Request

PUT /lls/v1.0/domain/ingest.example.com/authentication HTTP/1.1
{
"authentication": true,
"authenticationType": "default"
}

Successful Response Body

{
"domain": "ingest.example.com",
"created": "2025-07-10T09:30:00Z",
"authentication": true,
"authenticationType": "default",
"authenticationKey": "abcdef123456"
}

Enable 3rd party authentication

Request

PUT /lls/v1.0/domain/ingest-3rdparty.example.com/authentication HTTP/1.1
{
"domain": "ingest-3rdparty.example.com",
"authentication": true,
"authenticationType": "3rdparty",
"3rdPartyEndpoint": "https://auth.example.com/check"
}

Successful Response Body

{
"domain": "ingest-3rdparty.example.com",
"created": "2025-07-10T09:30:00Z",
"authentication": true,
"authenticationType": "3rdparty",
"3rdPartyEndpoint": "https://auth.example.com/check"
}

Disable token authentication

Request

PUT /lls/v1.0/domain/ingest.example.com/authentication HTTP/1.1
{
"authentication": false
}

Successful Response Body

{
"domain": "ingest.example.com",
"created": "2025-07-10T09:30:00Z",
"authentication": false
}

Best Practices

Rate Limiting

Rate Limits

Rate limiting is posed upon the API, please kindly check your API calls to ensure complying with the rate limit below:

  • 100 requests per minute
  • 1000 requests per hour