Pin graph nodes to a session

POST

/v1/session/{nameOrId}/pin

const url = 'http://localhost:8090/v1/session/example/pin';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"nodeIds":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8090/v1/session/example/pin \
  --header 'Content-Type: application/json' \
  --data '{ "nodeIds": [ "example" ] }'

Parameters

Path Parameters

nameOrId

required

string

Request Body^required

application/json

object

nodeIds

required

Array<string>

Example ^generated

{
  "nodeIds": [
    "example"
  ]
}

Responses

200

How many nodes were pinned

application/json

object

status

string

Allowed values: pinned

count

integer

Example

{
  "status": "pinned"
}