Environments-13
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
PATCH | |
DELETE | |
POST | |
POST | |
POST | |
POST | |
GET | |
GET | |
POST |
Retrieve environments file system
Required API key scopes
file_system:read
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /file_system /:id
Example response
Status 200
Update environments file system
Required API key scopes
file_system:write
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Response
Example request
PATCH
/api /environments /:project_id /file_system /:id
Example response
Status 200
Update environments file system
Required API key scopes
file_system:write
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Response
Example request
PATCH
/api /environments /:project_id /file_system /:id
Example response
Status 200
Delete environments file system
Required API key scopes
file_system:write
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /file_system /:id
Example response
Status 204 No response body
Delete environments file system
Required API key scopes
file_system:write
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /file_system /:id
Example response
Status 204 No response body
Create environments file system count
Get count of all files in a folder.
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /:id /count
Example response
Status 200 No response body
Create environments file system count
Get count of all files in a folder.
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /:id /count
Example response
Status 200 No response body
Create environments file system link
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /:id /link
Example response
Status 200 No response body
Create environments file system link
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /:id /link
Example response
Status 200 No response body
Create environments file system move
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /:id /move
Example response
Status 200 No response body
Create environments file system move
Path parameters
- idstring
A UUID string identifying this file system.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /:id /move
Example response
Status 200 No response body
Create environments file system count by path
Get count of all files in a folder.
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /count_by_path
Example response
Status 200 No response body
Create environments file system count by path
Get count of all files in a folder.
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Example request
POST
/api /environments /:project_id /file_system /count_by_path
Example response
Status 200 No response body
Retrieve environments file system unfiled
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /environments /:project_id /file_system /unfiled
Example response
Status 200 No response body
Retrieve environments file system unfiled
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /environments /:project_id /file_system /unfiled
Example response
Status 200 No response body
List all environments file system shortcut
Required API key scopes
file_system_shortcut:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET
/api /environments /:project_id /file_system_shortcut
Example response
Status 200
List all environments file system shortcut
Required API key scopes
file_system_shortcut:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET
/api /environments /:project_id /file_system_shortcut
Example response
Status 200
Create environments file system shortcut
Required API key scopes
file_system_shortcut:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
Response
Example request
POST
/api /environments /:project_id /file_system_shortcut