# Files

File actions

## Get permitted Enclaves

> Gets a list of Enclaves user is permitted to access

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"EnclaveInfo":{"type":"object","required":["id","name","assignee"],"properties":{"id":{"type":"string","description":"The Enclave Id"},"name":{"type":"string","description":"The Enclave name"},"assignee":{"allOf":[{"$ref":"#/components/schemas/Assignee"},{"type":"object","properties":{"displayName":{"type":"string"}}}]}}},"Assignee":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","$ref":"#/components/schemas/AssigneeType"}}},"AssigneeType":{"type":"string","enum":["user","group","profile"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/enclaves":{"get":{"summary":"Get permitted Enclaves","description":"Gets a list of Enclaves user is permitted to access","tags":["Files"],"parameters":[{"name":"ids","in":"query","required":false,"description":"The comma separated Enclave Ids","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{},"items":{"type":"array","$ref":"#/components/schemas/EnclaveInfo"}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Create an Enclave

> Create and assign an Enclave

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EnclaveCreateRequest":{"type":"object","required":["enclaveName","assignee"],"properties":{"enclaveName":{"type":"string","description":"The Enclave name"},"assignee":{"type":"object","$ref":"#/components/schemas/Assignee"},"storageType":{"type":"string","$ref":"#/components/schemas/StorageType"}}},"Assignee":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","$ref":"#/components/schemas/AssigneeType"}}},"AssigneeType":{"type":"string","enum":["user","group","profile"]},"StorageType":{"type":"string","enum":["S3"]},"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/enclaves":{"post":{"summary":"Create an Enclave","description":"Create and assign an Enclave","tags":["Files"],"requestBody":{"description":"Enclave create request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnclaveCreateRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## DELETE /v1/enclaves/{enclaveId}

> Delete an Enclave

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/enclaves/{enclaveId}":{"delete":{"summary":"Delete an Enclave","tags":["Files"],"parameters":[{"name":"enclaveId","in":"path","required":true,"description":"The Enclave Id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{},"items":{"type":"array"}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Assign an Enclave

> Assign an Enclave

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EnclaveAssignmentRequest":{"type":"object","required":["enclaveId","assignee"],"properties":{"enclaveId":{"type":"string","description":"The Enclave Id"},"assignee":{"type":"object","$ref":"#/components/schemas/Assignee"}}},"Assignee":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","$ref":"#/components/schemas/AssigneeType"}}},"AssigneeType":{"type":"string","enum":["user","group","profile"]},"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/enclaves/assignments/{enclaveId}":{"post":{"summary":"Assign an Enclave","description":"Assign an Enclave","tags":["Files"],"requestBody":{"description":"Enclave create request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnclaveAssignmentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## List files or download as zip file

> List or download files from Environment or Enclave

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]}}},"paths":{"/v1/transfer/resources/{id}":{"get":{"summary":"List files or download as zip file","description":"List or download files from Environment or Enclave","tags":["Files"],"parameters":[{"name":"id","in":"path","required":true,"description":"The Resource Id"},{"name":"name","in":"query","required":false,"description":"Set to provide custom zip file name"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}},"application/zip":{"description":"Download a zip file containing Resource files","headers":{"Content-Disposition":"attachment; filename=\"butler.zip\""}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Copy files

> Copy files between Environments and Enclaves

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TransferFilesRequest":{"type":"object","properties":{"action":{"type":"string","description":"Type of transfer","enum":["copy","export"],"required":true},"sourceId":{"type":"string","required":true,"description":"The source Resource Id"},"sourceName":{"type":"string","required":false,"description":"The source Resource Id"},"sourceType":{"$ref":"#/components/schemas/ResourceType","required":true,"description":"The source Resource Type"},"targetId":{"type":"string","required":false,"description":"The target Resource Id"},"targetType":{"$ref":"#/components/schemas/ResourceType","required":false,"description":"The target Resource Type"}}},"ResourceType":{"type":"string","enum":["environment","enclave"]},"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/transfer/resources/{id}":{"post":{"summary":"Copy files","description":"Copy files between Environments and Enclaves","tags":["Files"],"parameters":[{"name":"id","in":"path","required":true,"description":"The Resource Id"}],"requestBody":{"description":"Transfer request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFilesRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Delete all files

> Delete an Environment or Enclave file

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/transfer/resources/{id}":{"delete":{"summary":"Delete all files","description":"Delete an Environment or Enclave file","tags":["Files"],"parameters":[{"name":"id","in":"path","required":true,"description":"The Resource Id"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Download file

> Download a file from Environment or Enclave

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]}}},"paths":{"/v1/transfer/resources/{id}/{name}":{"get":{"summary":"Download file","description":"Download a file from Environment or Enclave","tags":["Files"],"parameters":[{"name":"id","in":"path","required":true,"description":"The Resource Id"},{"name":"name","in":"path","required":true,"description":"The Resource name"}],"responses":{"200":{"description":"Stream file content. Sets response Content-Disposition to attachment and MIME type from file."},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Upload a file

> Upload a file to an Environment or Enclave

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UploadFileRequest":{"type":"object","required":["filesize","filetype"],"properties":{"filesize":{"type":"string","description":"File content size"},"filetype":{"type":"string","description":"File MIME type"},"filestore":{"type":"string","description":"File storage Type","enum":["s3"]}}},"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/transfer/resources/{id}/{name}":{"put":{"summary":"Upload a file","description":"Upload a file to an Environment or Enclave","tags":["Files"],"parameters":[{"name":"id","in":"path","required":true,"description":"The Resource Id"},{"name":"name","in":"path","required":true,"description":"The Resource name"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadFileRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"422":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```

## Delete a file

> Delete an Environment or Enclave file

```json
{"openapi":"3.0.0","info":{"title":"Replica Butler","version":"4.4.0"},"tags":[{"name":"Files","description":"File actions"}],"servers":[{"url":"/butler/api","description":"Replica Butler"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReplicaMessageSuccess":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}},"ReplicaEvent":{"type":"string","enum":["GET","POST","PUT","DELETE","ERROR"]},"ReplicaMessageFailure":{"type":"object","properties":{"statusCode":{"type":"integer"},"success":{"type":"boolean"},"message":{"type":"string"},"event":{"type":"string","$ref":"#/components/schemas/ReplicaEvent"},"items":{"type":"array"}}}}},"paths":{"/v1/transfer/resources/{id}/{name}":{"delete":{"summary":"Delete a file","description":"Delete an Environment or Enclave file","tags":["Files"],"parameters":[{"name":"id","in":"path","required":true,"description":"The Resource Id"},{"name":"name","in":"path","required":true,"description":"The Resource name"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageSuccess"},{"type":"object","properties":{"message":{}}}]}}}},"500":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ReplicaMessageFailure"},{"type":"object","properties":{"message":{}}}]}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.replicacyber.com/developer-guide/butler-api-reference/files.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.