configpacks

Configuration for Configpack Configuration resource.

Read/write properties

namespace<String>

Namespace of the StyleBook.
Minimum length = 1
Maximum length = 32

name<String>

Name of the StyleBook.

target_devices_json<Object>

Target devices that are used to instantiate the StyleBook.

version<String>

Version of the StyleBook.
Minimum length = 1
Maximum length = 32

config_id<String>

Config ID for the config pack.

job_id<String>

Config ID for the config pack.

id<String>

Config ID for the config pack.

parameters<Object>

Parameters used to instantiate the configuration for the stylebook. Please refer to the schema api to view the supported parameters for any stylebook.

targets<Object>

Target devices that are used to instantiate the StyleBook.

created_datetime<String>

Datetime the configuration for a stylebook was created.
Minimum length = 1
Maximum length = 128

Read only properties

outputs<Object>

Outputs that are obtained after instantiating the stylebook definition. .

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>//configpacks

HTTPS Method:POST

HTTPS Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"configpack": {
      "parameters":< property_value>
      "targets":< property_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "configpack":{
      "config_id":< property_value>
      "job_id":< property_value>}}

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/configpacks

Query-parameters:

HTTPS Method:GET

HTTPS Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "configpacks":[{
      "namespace":<String_value>,
      "name":<String_value>,
      "outputs":<Object_value>,
      "target_devices_json":<Object_value>,
      "version":<String_value>,
      "config_id":<String_value>,
      "job_id":<String_value>,
      "id":<String_value>,
      "parameters":<Object_value>,
      "targets":<Object_value>,
      "created_datetime":<String_value>}]}

get

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>/<config_id_value>/configpacks

HTTPS Method:GET

HTTPS Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "configpack":{
      "namespace":<String_value>,
      "name":<String_value>,
      "outputs":<Object_value>,
      "target_devices_json":<Object_value>,
      "version":<String_value>,
      "config_id":<String_value>,
      "job_id":<String_value>,
      "id":<String_value>,
      "parameters":<Object_value>,
      "targets":<Object_value>,
      "created_datetime":<String_value>}}

update

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>/<config_id_value>/configpacks/<config_id_value>

HTTPS Method:PUT

HTTPS Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"configpack":{}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "configpack":{
      "config_id":< property_value>
      "job_id":< property_value>}}

delete

URL:https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>/<config_id_value>/configpacks/<config_id_value>

HTTPS Method:DELETE

HTTPS Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "configpack":{
      "config_id":< property_value>
      "job_id":< property_value>}}