Skip to content

Commit 88fea48

Browse files
authored
add RDC DELETE API endpoint (#2732)
1 parent 2e19c4b commit 88fea48

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

docs/dev/api/rdc.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1173,3 +1173,71 @@ curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
11731173
</details>
11741174

11751175
---
1176+
1177+
### Delete a Job
1178+
1179+
<details><summary><span className="api delete">DELETE</span> <code>/v1/rdc/jobs/&#123;job_id&#125;</code></summary>
1180+
<p/>
1181+
1182+
Delete a job and all of its assets from the Sauce Labs test history.
1183+
1184+
#### Parameters
1185+
1186+
<table id="table-api">
1187+
<tbody>
1188+
<tr>
1189+
<td><code>job_id</code></td>
1190+
<td><p><small>| PATH | REQUIRED | STRING |</small></p><p>The unique identifier of a job running on a real device in the data center. You can look up job IDs using the <a href="#get-real-device-jobs">Get Real Device Jobs</a> endpoint.</p></td>
1191+
</tr>
1192+
</tbody>
1193+
</table>
1194+
1195+
<Tabs
1196+
groupId="dc-url"
1197+
defaultValue="us"
1198+
values={[
1199+
{label: 'United States', value: 'us'},
1200+
{label: 'Europe', value: 'eu'},
1201+
]}>
1202+
1203+
<TabItem value="us">
1204+
1205+
```jsx title="Sample Request"
1206+
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
1207+
--request DELETE 'https://api.us-west-1.saucelabs.com/v1/rdc/jobs/a2f60bf3ea5f43fa90126f82c0ba2cf6' | json_pp
1208+
```
1209+
1210+
</TabItem>
1211+
1212+
<TabItem value="eu">
1213+
1214+
```jsx title="Sample Request"
1215+
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
1216+
--request DELETE 'https://api.eu-central-1.saucelabs.com/v1/rdc/jobs/a2f60bf3ea5f43fa90126f82c0ba2cf6' | json_pp
1217+
```
1218+
1219+
</TabItem>
1220+
</Tabs>
1221+
1222+
#### Responses
1223+
1224+
<table id="table-api">
1225+
<tbody>
1226+
<tr>
1227+
<td><code>200</code></td>
1228+
<td colSpan='2'>Job successfully deleted.</td>
1229+
</tr>
1230+
</tbody>
1231+
<tbody>
1232+
<tr>
1233+
<td><code>404</code></td>
1234+
<td colSpan='2'>Not found.</td>
1235+
</tr>
1236+
</tbody>
1237+
</table>
1238+
1239+
No payload is returned with the successful deletion.
1240+
1241+
</details>
1242+
1243+
---

0 commit comments

Comments
 (0)