Skip to content

feat: Add docs for run/build DELETE endpoint #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 10, 2023
Merged

feat: Add docs for run/build DELETE endpoint #727

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
90c49f3
Add docs for run/build DELETE
Jkuzz Oct 5, 2023
9babdc0
Update spelling
Jkuzz Oct 5, 2023
d026896
Update response code
Jkuzz Oct 9, 2023
da41916
Update sources/platform/api_v2/api_v2_reference.apib
Jkuzz Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions sources/platform/api_v2/api_v2_reference.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2213,6 +2213,19 @@ This endpoint does not require the authentication token. The calls are authentic
+ Attributes
- data (Run, required)

## Delete run [/v2/actor-runs/{runId}{?token}]

### Delete run [DELETE]

Delete the run. Only finished runs can be deleted. Only the person or organization that initiated the run can delete it.

+ Parameters

+ runId: `3KH8gEpp4d8uQSe8T` (string, required) - Run ID.
+ token: `soSkq9ekdmfOslopH` (string, required) - API authentication token.

+ Response 204 (application/json)

## Abort run [/v2/actor-runs/{runId}/abort{?token,gracefully}]

### Abort run [POST]
Expand Down Expand Up @@ -2393,6 +2406,19 @@ This endpoint does not require the authentication token. The calls are authentic
+ Attributes
- data (Build, required)

## Delete build [/v2/actor-builds/{buildId}{?token}]

### Delete build [DELETE]

Delete the build. The build that is the current default build for the Actor cannot be deleted.
Only users with build permissions for the Actor can delete builds.

+ Parameters

+ buildId: `soSkq9ekdmfOslopH` (string, required) - ID of the build you want to get, found in the build's `Info` tab.
+ token: `soSkq9ekdmfOslopH` (string, required) - API authentication token.

+ Response 204 (application/json)

## Abort build [/v2/actor-builds/{buildId}/abort{?token}]

Expand Down