Startup config

GET /user/:user_code/sa/:sa_code/config/startup

Read list of Startup config summaries

Detail

Request

No Parameters

Response

Body

Key

Type

Value

results

Array

List of Running config summaries

Sample

Request

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/startup

Response

Body
{
  "results": [
    {
      "moduleId": 0,
      "moduleName": "SEIL/B1 3.71 (Symphony8)",
      "version": "3.71.0-0",
      "binary": false,
      "lastModified": "2012/06/18 10:36:48"
    },
    {
      "moduleId": 1,
      "moduleName": "update-firmware",
      "version": "0.0.0-0",
      "binary": false,
      "lastModified": "2012/06/18 10:36:48"
    }
  ]
}

PUT /user/:user_code/sa/:sa_code/config/startup

Reflect Working config, or template set content onto Startup config

Detail

Request

No Parameters

Response (when reflect successful)

Status Code
204
Header
Content-Type: text/plain
Body

No Body

Response (when reflect fails)

Recipe-compatible service adaptors only. Reflect fails if the system determines the config cannot be reflected on the equipment

Status Code
400
Header
Content-Type: application/json
Body

Key

Type

Value

results

Array

List of fail reasons

row int

Config row No. (0 is shown if location not specified)

column int

Column No. indicating location of error (0 is shown if location not specified)

error String

Cause of error

line String

Config line content

label String

Error label

recipe

Recipe code’s limitation error

syntax

Syntax error

Sample

Request

URL
PUT https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/startup
Body

No Body

Response (when reflect successful)

Header
Content-Type: text/plain
Body

No Body

Response (when reflect fails)

Header
Content-Type: application/json
Body
{
  "results": [
    {
      "row": 3,
      "column ":null,
      "error": "invalidaddress:dhcpd",
      "line": "route.ipv4.0.gateway",
      "label": "syntax"
    },
    {
      "row": 4,
      "column" :null,
      "error": "unknownkey.",
      "line": "key",
      "label": "syntax"
    },
    {
      "row": 4,
      "column": null,
      "error": "refusekeyname.",
      "line": "key",
      "label": "recipe"
    }
  ]
}

GET /user/:user_code/sa/:sa_code/config/startup/:module_id/plain

Read Startup config (text format) of specified module

Detail

Request

No Parameters

Response

Header
Content-Type: text/plain
Body

Config (text)

Sample

Request

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/startup/0/plain

Response

Header
Content-Type: application/json
Body
hostname "sample"
interface lan0 add 192.168.0.1/24
interface lan1 add dhcp
route add default dhcp
telnetd enable

GET /user/:user_code/sa/:sa_code/config/startup/:module_id/binary

Read Startup config (binary format) of specified module

Detail

Request

No Parameters

Response

Header
Content-Type: application/octet-stream
Body

Config (binary)

Sample

Request

URL
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/sa/tss99990001/config/startup/0/binary

Response

Header
Content-Type: application/octet-stream
Body

Config (binary)