Harness

Agent mTLS Endpoint Management

Contains APIs related to Agent mTLS Endpoint management.

Gets the agent mTLS endpoint for an account.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

The mTLS endpoint for the account.

get/ng/api/agent/mtls/endpoint
Request samples 
curl -i -X GET \
  'https://app.harness.io/ng/api/agent/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 the existing agent mTLS endpoint for an account.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

The details to update for the agent 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/agent/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": [
    ]
}

Creates the agent mTLS endpoint for an account.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

The details of the agent 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/agent/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": [
    ]
}

Removes the agent mTLS endpoint for an account.

Securityx-api-key
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/agent/mtls/endpoint
Request samples 
curl -i -X DELETE \
  'https://app.harness.io/ng/api/agent/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 agent mTLS endpoint for an account.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json
required

A subset of the details to update for the agent 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/agent/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": [
    ]
}

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

Securityx-api-key
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 mTLS endpoint.

get/ng/api/agent/mtls/check-availability
Request samples 
curl -i -X GET \
  'https://app.harness.io/ng/api/agent/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": [
    ]
}
➔ Next to Delegate Download Resource