Validate Endpoint Using POST

Validate Endpoint Using POST

Validates the given endpoint

Request
URI
POST
http://cava-s-182-041.eng.vmware.com//codestream/api/endpoint-validation
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

Request Body

Endpoint specification

EndpointValidationSpec of type(s) application/json
Required 
{
    "description": "string",
    "id": "string",
    "isRestricted": false,
    "name": "My-Name",
    "project": "My-Project",
    "type": "jenkins"
}
string
description
Required

A human-friendly description.

string
id
Optional

id of the endpoint, if already present

boolean
isRestricted
Optional

This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
project
Optional

The project this entity belongs to.

object
properties
Required

Endpoint specific properties

string
type
Required

The type of this Endpoint instance.

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with endpoint validations

Returns TileExecutorResponse of type(s) application/json 
{
    "duration": 0,
    "status": "COMPLETED",
    "statusMessage": "Failed to connect to jenkins server endpoint"
}
integer As int64 As int64
duration
Optional

time taken for the Tile execution to finish.

object
output
Optional

Output properties from the Tile execution.

string
status
Optional

Status of the Tile execution.

Possible values are : CREATED, STARTED, PAUSED, CANCELED, COMPLETED, FAILED,
string
statusMessage
Optional

Status message of the Tile execution.


401

Unauthorized Request

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Server Error

Operation doesn't return any data structure

On This Page
Endpoints Operations
POST
Create Using POST 1
DELETE
Delete Using DELETE 1
DELETE
Delete Using DELETE 2
GET
Get All Using GET
GET
Get By Id Using GET
GET
Get By Name Using GET
GET
Get Endpoint Properties Using GET
GET
Get Endpoint Tiles Using GET
GET
Get Using GET
PUT
Update By Id Using PUT 1
PUT
Update By Name Using PUT 1
POST
Validate Endpoint Using POST