Environments-12

For instructions on how to authenticate to use this endpoint, see API overview.

Get count of all files in a folder.

Create environments file system count

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system count

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system link

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system link

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system move

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system move

Path parameters

  • id
    string

    A UUID string identifying this file system.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system count by path

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Create environments file system count by path

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Retrieve environments file system unfiled

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Retrieve environments file system unfiled

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

List all environments file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response

Status 200
RESPONSE
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

List all environments file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response

Status 200
RESPONSE
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Create environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 201
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Create environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 201
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Retrieve environments file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

  • id
    string

    A UUID string identifying this file system shortcut.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Retrieve environments file system shortcut

Required API key scopes

file_system_shortcut:read

Path parameters

  • id
    string

    A UUID string identifying this file system shortcut.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Update environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • id
    string

    A UUID string identifying this file system shortcut.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Update environments file system shortcut

Required API key scopes

file_system_shortcut:write

Path parameters

  • id
    string

    A UUID string identifying this file system shortcut.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"type": "string",
"ref": "string",
"href": "string",
"created_at": "2019-08-24T14:15:22Z"
}
Next page →

Community questions

Questions about this page? or post a community question.