API

This section contains information on how to use the Vela API.

Authentication

Learn how authenticating to the Vela API works.

Admin

Learn how to use API endpoints as an admin of the platform.

Build

Learn how to use API endpoints for the build resource.

Dashboard

Learn how to use API endpoints for the dashboard resource.

Deployment

Learn how to use API endpoints for the deployment resource.

Hook

Learn how to use API endpoints for the hook resource.

Metrics

Learn how to use API endpoints for retrieving platform metrics.

Pipeline

Learn how to use API endpoints for the pipeline resource.

Repo

Learn how to use API endpoints for the repo resource.

Schedule

Learn how to use API endpoints for the schedule resource.

SCM

Learn how to use API endpoints for the SCM resource.

Secret

Learn how to use API endpoints for the secret resource.

Service

Learn how to use API endpoints for the service resource.

Step

Learn how to use API endpoints for the step resource.

User

Learn how to use API endpoints for the user resource.