Delegate mTLS Endpoint Management

Contains APIs related to Delegate mTLS Endpoint management.

Checks whether a given delegate mTLS endpoint domain prefix is available.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

domainPrefix
required
string

The domain prefix to check.

Responses
400

Bad Request

500

Internal server error

default

True if and only if the domain prefix is currently not in use by any existing delegate mTLS endpoint.

get/ng/api/delegate-mtls/check-availability
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/delegate-mtls/check-availability?accountIdentifier=string&domainPrefix=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Creates the delegate mTLS endpoint for an account.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

The details of the delegate mTLS endpoint to create.

domainPrefix
string
caCertificates
string
mode
string
Enum: "LOOSE" "STRICT"
Responses
400

Bad Request

500

Internal server error

default

The details of the newly created mTLS endpoint.

post/ng/api/delegate-mtls/endpoint
Request samples
application/json
{
  • "domainPrefix": "string",
  • "caCertificates": "string",
  • "mode": "LOOSE"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets the delegate mTLS endpoint for an account.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

The delegate mTLS endpoint for the account.

get/ng/api/delegate-mtls/endpoint
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/delegate-mtls/endpoint?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Removes the delegate mTLS endpoint for an account.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

True if and only if the endpoint existed and got removed.

delete/ng/api/delegate-mtls/endpoint
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/ng/api/delegate-mtls/endpoint?accountIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates selected properties of the existing delegate mTLS endpoint for an account.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

A subset of the details to update for the delegate mTLS endpoint.

domainPrefix
string
caCertificates
string
mode
string
Enum: "LOOSE" "STRICT"
Responses
400

Bad Request

500

Internal server error

default

The details of the updated mTLS endpoint.

patch/ng/api/delegate-mtls/endpoint
Request samples
application/json
{
  • "domainPrefix": "string",
  • "caCertificates": "string",
  • "mode": "LOOSE"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates the existing delegate mTLS endpoint for an account.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

The details to update for the delegate mTLS endpoint.

domainPrefix
string
caCertificates
string
mode
string
Enum: "LOOSE" "STRICT"
Responses
400

Bad Request

500

Internal server error

default

The details of the updated mTLS endpoint.

put/ng/api/delegate-mtls/endpoint
Request samples
application/json
{
  • "domainPrefix": "string",
  • "caCertificates": "string",
  • "mode": "LOOSE"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}