Environments-14

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

Get count of all files in a folder.

Endpoints

POST
POST
POST
POST
GET
POST
GET
GET
POST
GET

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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/:id/count
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/:id/count/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/:id/count
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/:id/count/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/:id/link
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/:id/link/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/:id/link
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/:id/link/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/:id/move
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/:id/move/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/:id/move
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/:id/move/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/count_by_path
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/count_by_path/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/count_by_path
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/count_by_path/\
-d path="string"

Example response

Status 200 No response body

Retrieve environments file system log view

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/.


Example request

GET /api/environments/:project_id/file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/log_view/

Example response

Status 200 No response body

Retrieve environments file system log view

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/.


Example request

GET /api/environments/:project_id/file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/log_view/

Example response

Status 200 No response body

Create environments file system log view

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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/log_view/\
-d path="string"

Example response

Status 200 No response body

Create environments file system log view

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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/environments/:project_id/file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/log_view/\
-d path="string"

Example 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/.


Example request

GET /api/environments/:project_id/file_system/unfiled
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system/unfiled/

Example 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/.


Example request

GET /api/environments/:project_id/file_system/unfiled
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/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_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


Example request

GET /api/environments/:project_id/file_system_shortcut
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system_shortcut/

Example 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


Example request

GET /api/environments/:project_id/file_system_shortcut
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system_shortcut/

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string

Response


Example request

POST /api/environments/:project_id/file_system_shortcut
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system_shortcut/\
-d path="string"

Example 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/.


Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string

Response


Example request

POST /api/environments/:project_id/file_system_shortcut
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system_shortcut/\
-d path="string"

Example 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


Example request

GET /api/environments/:project_id/file_system_shortcut/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system_shortcut/:id/

Example 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


Example request

GET /api/environments/:project_id/file_system_shortcut/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:project_id/file_system_shortcut/:id/

Example 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.