Validate
Endpoint
POST /api/v1/pipelines/:org/:repo/:pipeline/validate
Parameters
The following parameters are used to configure the endpoint:
| Name | Description |
|---|---|
org | name of organization |
repo | name of repository |
pipeline | commit SHA for pipeline from repository |
output | format the output for the compiled pipeline configuration |
Permissions
COMING SOON!
Responses
| Status Code | Description |
|---|---|
200 | indicates the request has succeeded |
400 | unable to retrieve or validate the pipeline configuration and templates |
401 | indicates the user does not have proper permissions |
404 | unable to retrieve or validate the pipeline configuration or templates |
500 | system error while retrieving or validating the pipeline configuration templates |
Sample
warning
This section assumes you already know how to authenticate to the API.
To authenticate to the API, please review the authentication documentation.
Request
curl \
-X POST \
-H "Authorization: Bearer <token>" \
"http://127.0.0.1:8080/api/v1/pipelines/github/octocat/48afb5bdc41ad69bf22588491333f7cf71135163/validate"
Response
"pipeline is valid"