Archive Deployment changedapi/beta/deployments/archive
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+91added
Lines−142removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits18to this page, all time
# Archive Deployment ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Archive Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The whole hunk
from line 1, old and new numbered
/
from line 1
1---
2title: Archive Deployment
3url: https://platform.claude.com/docs/en/api/beta/deployments/archive
4---
1# Archive Deployment
52
6## Archive Deployment
3**POST** `/v1/deployments/{deployment_id}/archive`
74
8**post** `/v1/deployments/{deployment_id}/archive`
9
105Archive Deployment
116
12### Path Parameters
7## Path parameters
138
149- `deployment_id: string`
1510
16### Header Parameters
11## Headers
1712
1813- `"anthropic-beta": optional array of AnthropicBeta`
1914
from line 86
9186
9287 - `"mid-conversation-tool-changes-2026-07-01"`
9388
94### Returns
89## Returns
9590
96- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`
91- `BetaManagedAgentsDeployment object`
9792
9893 A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.
9994
from line 104
109104
110105 - `type: "agent"`
111106
112 - `"agent"`
113
114107 - `version: number`
115108
109 format: int32
110
116111 - `archived_at: string or null`
117112
118113 A timestamp in RFC 3339 format
119114
115 format: date-time
116
120117 - `created_at: string`
121118
122119 A timestamp in RFC 3339 format
123120
121 format: date-time
122
124123 - `description: string or null`
125124
126125 Description of what the deployment does.
from line 132
133132
134133 Events sent to each session immediately after creation.
135134
136 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
135 - `BetaManagedAgentsDeploymentUserMessageEvent object`
137136
138137 A user message sent to the session.
139138
from line 140
141140
142141 Array of content blocks for the user message.
143142
144 - `BetaManagedAgentsTextBlock object { text, type }`
143 - `BetaManagedAgentsTextBlock object`
145144
146145 Regular text content.
147146
from line 148
149148
150149 The text content.
151150
151 minLength: 1
152
152153 - `type: "text"`
153154
154 - `"text"`
155 - `BetaManagedAgentsImageBlock object`
155156
156 - `BetaManagedAgentsImageBlock object { source, type }`
157
158157 Image content specified directly as base64 data or as a reference via a URL.
159158
160159 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
from line 160
161160
162161 Union type for image source variants.
163162
164 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
163 - `BetaManagedAgentsBase64ImageSource object`
165164
166165 Base64-encoded image data.
167166
from line 168
169168
170169 Base64-encoded image data.
171170
171 minLength: 1
172
172173 - `media_type: string`
173174
174175 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
175176
177 minLength: 1
178
176179 - `type: "base64"`
177180
178 - `"base64"`
181 - `BetaManagedAgentsURLImageSource object`
179182
180 - `BetaManagedAgentsURLImageSource object { type, url }`
181
182183 Image referenced by URL.
183184
184185 - `type: "url"`
185186
186 - `"url"`
187
188187 - `url: string`
189188
190189 URL of the image to fetch.
191190
192 - `BetaManagedAgentsFileImageSource object { file_id, type }`
191 minLength: 1
193192
193 - `BetaManagedAgentsFileImageSource object`
194
194195 Image referenced by file ID.
195196
196197 - `file_id: string`
from line 198
197198
198199 ID of a previously uploaded file.
199200
201 minLength: 1
202
200203 - `type: "file"`
201204
202 - `"file"`
203
204205 - `type: "image"`
205206
206 - `"image"`
207 - `BetaManagedAgentsDocumentBlock object`
207208
208 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
209
210209 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
211210
212211 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
from line 212
213212
214213 Union type for document source variants.
215214
216 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
215 - `BetaManagedAgentsBase64DocumentSource object`
217216
218217 Base64-encoded document data.
219218
from line 220
221220
222221 Base64-encoded document data.
223222
223 minLength: 1
224
224225 - `media_type: string`
225226
226227 MIME type of the document (e.g., "application/pdf").
227228
229 minLength: 1
230
228231 - `type: "base64"`
229232
230 - `"base64"`
233 - `BetaManagedAgentsPlainTextDocumentSource object`
231234
232 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
233
234235 Plain text document content.
235236
236237 - `data: string`
from line 238
237238
238239 The plain text content.
239240
241 minLength: 1
242
240243 - `media_type: "text/plain"`
241244
242245 MIME type of the text content. Must be "text/plain".
243246
244 - `"text/plain"`
245
246247 - `type: "text"`
247248
248 - `"text"`
249 - `BetaManagedAgentsURLDocumentSource object`
249250
250 - `BetaManagedAgentsURLDocumentSource object { type, url }`
251
252251 Document referenced by URL.
253252
254253 - `type: "url"`
255254
256 - `"url"`
257
258255 - `url: string`
259256
260257 URL of the document to fetch.
261258
262 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`
259 minLength: 1
263260
261 - `BetaManagedAgentsFileDocumentSource object`
262
264263 Document referenced by file ID.
265264
266265 - `file_id: string`
from line 266
267266
268267 ID of a previously uploaded file.
269268
269 minLength: 1
270
270271 - `type: "file"`
271272
272 - `"file"`
273
274273 - `type: "document"`
275274
276 - `"document"`
277
278275 - `context: optional string or null`
279276
280277 Additional context about the document for the model.
from line 280
283280
284281 The title of the document.
285282
286 - `BetaManagedAgentsRedactedBlock object { type }`
283 - `BetaManagedAgentsRedactedBlock object`
287284
288285 Placeholder for content withheld by Anthropic model policy.
289286
290287 - `type: "redacted"`
291288
292 - `"redacted"`
293
294289 - `type: "user.message"`
295290
296 - `"user.message"`
291 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`
297292
298 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`
299
300293 An outcome the agent should work toward. The agent begins work on receipt.
301294
302295 - `description: string`
from line 300
307300
308301 Rubric for grading the quality of an outcome.
309302
310 - `BetaManagedAgentsFileRubric object { file_id, type }`
303 - `BetaManagedAgentsFileRubric object`
311304
312305 Rubric referenced by a file uploaded via the Files API.
313306
from line 310
317310
318311 - `type: "file"`
319312
320 - `"file"`
313 - `BetaManagedAgentsTextRubric object`
321314
322 - `BetaManagedAgentsTextRubric object { content, type }`
323
324315 Rubric content provided inline as text.
325316
326317 - `content: string`
from line 320
329320
330321 - `type: "text"`
331322
332 - `"text"`
333
334323 - `type: "user.define_outcome"`
335324
336 - `"user.define_outcome"`
337
338325 - `max_iterations: optional number or null`
339326
340327 Eval→revision cycles before giving up. Default 3, max 20.
341328
342 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`
329 format: int32
343330
331 - `BetaManagedAgentsDeploymentSystemMessageEvent object`
332
344333 Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt.
345334
346335 - `content: array of BetaManagedAgentsSystemContentBlock`
from line 340
351340
352341 The text content.
353342
343 minLength: 1
344
354345 - `type: "text"`
355346
356 - `"text"`
357
358347 - `type: "system.message"`
359348
360 - `"system.message"`
361
362349 - `metadata: map[string]`
363350
364351 Arbitrary key-value metadata. Maximum 16 pairs.
from line 358
371358
372359 Why a deployment is paused. Non-null exactly when `status` is `paused`.
373360
374 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`
361 - `BetaManagedAgentsManualDeploymentPausedReason object`
375362
376363 The caller invoked the pause endpoint on the deployment.
377364
378365 - `type: "manual"`
379366
380 - `"manual"`
367 - `BetaManagedAgentsErrorDeploymentPausedReason object`
381368
382 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`
383
384369 A scheduled fire recorded a failed run whose error auto-pauses the deployment.
385370
386371 - `error: BetaManagedAgentsDeploymentPausedReasonError`
from line 372
387372
388373 The error that triggered an auto-pause. Matches the failed run's `error.type`.
389374
390 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`
375 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
391376
392377 The deployment's environment was archived.
393378
394379 - `type: "environment_archived_error"`
395380
396 - `"environment_archived_error"`
381 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`
397382
398 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`
399
400383 The deployment's agent was archived.
401384
402385 - `type: "agent_archived_error"`
403386
404 - `"agent_archived_error"`
387 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`
405388
406 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`
407
408389 The deployment's environment no longer exists.
409390
410391 - `type: "environment_not_found_error"`
411392
412 - `"environment_not_found_error"`
393 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`
413394
414 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`
415
416395 A vault referenced by the deployment no longer exists.
417396
418397 - `type: "vault_not_found_error"`
419398
420 - `"vault_not_found_error"`
399 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`
421400
422 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`
423
424401 A file resource referenced by the deployment no longer exists.
425402
426403 - `type: "file_not_found_error"`
427404
428 - `"file_not_found_error"`
405 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`
429406
430 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`
431
432407 A referenced resource no longer exists and its kind was not reported.
433408
434409 - `type: "session_resource_not_found_error"`
435410
436 - `"session_resource_not_found_error"`
411 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`
437412
438 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`
439
440413 The deployment's workspace was archived.
441414
442415 - `type: "workspace_archived_error"`
443416
444 - `"workspace_archived_error"`
417 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`
445418
446 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`
447
448419 The deployment's organization is disabled.
449420
450421 - `type: "organization_disabled_error"`
451422
452 - `"organization_disabled_error"`
423 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`
453424
454 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`
455
456425 A memory store referenced by the deployment is archived.
457426
458427 - `type: "memory_store_archived_error"`
459428
460 - `"memory_store_archived_error"`
429 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`
461430
462 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`
463
464431 A skill referenced by the deployment's agent no longer exists.
465432
466433 - `type: "skill_not_found_error"`
467434
468 - `"skill_not_found_error"`
435 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`
469436
470 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`
471
472437 A vault referenced by the deployment is archived.
473438
474439 - `type: "vault_archived_error"`
475440
476 - `"vault_archived_error"`
441 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`
477442
478 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`
479
480443 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.
481444
482445 - `type: "unknown_error"`
483446
484 - `"unknown_error"`
447 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`
485448
486 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`
487
488449 The deployment configures resources, but its environment is self-hosted and cannot mount them.
489450
490451 - `type: "self_hosted_resources_unsupported_error"`
491452
492 - `"self_hosted_resources_unsupported_error"`
453 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`
493454
494 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`
495
496455 An MCP server host used by the deployment's agent is blocked by the environment's network policy.
497456
498457 - `type: "mcp_egress_blocked_error"`
499458
500 - `"mcp_egress_blocked_error"`
501
502459 - `type: "error"`
503460
504 - `"error"`
505
506461 - `resources: array of BetaManagedAgentsSessionResourceConfig`
507462
508463 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.
509464
510 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`
465 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`
511466
512467 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.
513468
514469 - `type: "github_repository"`
515470
516 - `"github_repository"`
517
518471 - `url: string`
519472
520473 Github URL of the repository
from line 476
523476
524477 Branch or commit to check out. Defaults to the repository's default branch.
525478
526 - `BetaManagedAgentsBranchCheckout object { name, type }`
479 - `BetaManagedAgentsBranchCheckout object`
527480
528481 - `name: string`
529482
530483 Branch name to check out.
531484
485 minLength: 1, maxLength: 255
486
532487 - `type: "branch"`
533488
534 - `"branch"`
489 - `BetaManagedAgentsCommitCheckout object`
535490
536 - `BetaManagedAgentsCommitCheckout object { sha, type }`
537
538491 - `sha: string`
539492
540493 Full commit SHA to check out.
541494
495 minLength: 7, maxLength: 64
496
542497 - `type: "commit"`
543498
544 - `"commit"`
545
546499 - `mount_path: optional string or null`
547500
548501 Mount path in the container. Defaults to `/workspace/<repo-name>`.
549502
550 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`
503 - `BetaManagedAgentsFileResourceConfig object`
551504
552505 A file mounted into each session's container.
553506
from line 510
557510
558511 - `type: "file"`
559512
560 - `"file"`
561
562513 - `mount_path: optional string or null`
563514
564515 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
565516
566 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`
517 - `BetaManagedAgentsMemoryStoreResourceConfig object`
567518
568519 A memory store attached to each session created from this deployment.
569520
from line 524
573524
574525 - `type: "memory_store"`
575526
576 - `"memory_store"`
577
578527 - `access: optional "read_write" or "read_only" or null`
579528
580529 Access mode for an attached memory store.
from line 544
595544
596545 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).
597546
547 minLength: 1, maxLength: 256
548
598549 - `timezone: string`
599550
600551 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
601552
553 minLength: 1
554
602555 - `type: "cron"`
603556
604 - `"cron"`
605
606557 - `last_run_at: optional string or null`
607558
608559 A timestamp in RFC 3339 format
609560
561 format: date-time
562
610563 - `upcoming_runs_at: optional array of string`
611564
612565 Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time.
from line 574
621574
622575 - `type: "deployment"`
623576
624 - `"deployment"`
625
626577 - `updated_at: string`
627578
628579 A timestamp in RFC 3339 format
629580
581 format: date-time
582
630583 - `vault_ids: array of string`
631584
632585 Vault IDs supplying stored credentials for sessions created from this deployment.
from line 600
647600
648601 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.
649602
650 - `"USD"`
651
652603 - `type: "limit"`
653604
654 - `"limit"`
605## Example
655606
656### Example
657
658```http
607```bash
659608curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/archive \
660609 -X POST \
661610 -H 'anthropic-version: 2023-06-01' \
from line 612
663612 -H "X-Api-Key: $ANTHROPIC_API_KEY"
664613```
665614
666#### Response
615### Response (200)
667616
668617```json
669618{
No line in this hunk matches that.