Response [200 Ok]

Uri /api/v2/node/Pc54BM!unlock
UriDescription Unlocks a password-protected node.
EndpointType UnlockNode

Timing

Total

cycles 1
objects 0
time 0.03225

Request

Uri /api/v2/node/Pc54BM!unlock
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /node
  • /
  • !unlock

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Read

Parameters

POST

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/node/Pc54BM!unlock"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "Password",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": 50
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "node"
            },
            {
                "type": "singleparam",
                "param_name": "nodeid",
                "param_value": "Pc54BM",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "unlock"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/Pc54BM!unlock",
        "UriDescription": "Unlocks a password-protected node.",
        "EndpointType": "UnlockNode",
        "Timing": {
            "Total": {
                "time": 0.03225,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}