Skip to main content
A newer release of this product is available.

Initialize a SnapLock ComplianceClock

Contributors
PDFs

POST /storage/snaplock/compliance-clocks

Introduced In: 9.10

Initializes the SnapLock ComplianceClock.

Required properties

  • node.name or node.uuid - Name or UUID of the node.

  • snaplock compliance-clock initialize

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

node

node

time

string

Compliance clock time
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "time": "2018-06-04T19:00:00Z"
}

Response

Status: 201, Created
Name Type Description

_links

_links

node

node

time

string

Compliance clock time
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "time": "2018-06-04T19:00:00Z"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

snaplock_compliance_clock

Name Type Description

_links

_links

node

node

time

string

Compliance clock time

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.