Skip to content

nodes_exports_create

POST
/api/nodes/{node_id}/exports/
curl --request POST \
--url https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/exports/ \
--header 'Authorization: Bearer <token>' \
--header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Export a node to a JSON file.

node_id
required
string format: uuid

Node ID

X-Workspace
required
string format: uuid

Workspace ID

Media typeapplication/json

Serializer for task status.

object
export_id
required
string
status
required
  • SUCCESS - SUCCESS
  • REVOKED - REVOKED
  • RECEIVED - RECEIVED
  • RETRY - RETRY
  • STARTED - STARTED
  • FAILURE - FAILURE
  • PENDING - PENDING
string
Allowed values: SUCCESS REVOKED RECEIVED RETRY STARTED FAILURE PENDING

Example

{
"status": "SUCCESS"
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "forbidden",
"message": "You do not have permission to perform this operation. Check the `details` property for more details.",
"details": [
{
"parameter": "plugin",
"message": "Not a member of the node.",
"code": "unauthorized"
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "object_not_found",
"message": "Object not found. Check the `details` property for more details.",
"details": [
{
"parameter": "<id>",
"code": "does_not_exist",
"message": "\"<id>\" does not exist."
}
]
}