Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetHarnessEndpoint

Operation to get a single harness endpoint.

Request Syntax


GET /harnesses/harnessId/endpoints/endpointName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

endpointName

The name of the endpoint to retrieve.

Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}

Required: Yes

harnessId

The ID of the harness that the endpoint belongs to.

Pattern: [a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "endpoint": { 
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "endpointName": "string",
      "failureReason": "string",
      "harnessId": "string",
      "harnessName": "string",
      "liveVersion": "string",
      "status": "string",
      "targetVersion": "string",
      "updatedAt": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

endpoint

The endpoint resource.

Type: HarnessEndpoint object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400