StyleBook configuration

Use API to import custom StyleBooks

September 22, 2022

Contributed by:

R R C

You can now use the StyleBook APIs to import custom StyleBooks into Citrix ADM. Use REST API to create a configuration pack from this StyleBook as follows in any tool such as the cURL command line tool or the Postman chrome browser extension. For example, you can import a StyleBook named example-lb that can be used to create a load balancer configuration on a Citrix ADC instance.

HTTP Method: POST

URL: http://<mas-ip>/stylebook/nitro/v2/config/stylebooks

Headers:

Content-Type: application/json
Accept: application/json
<!--NeedCopy-->

RequestBody:

{
       "stylebook":
  {
     "file\_name": "example-lb.yaml",
     "source": "<base64-contents>",
     "encoding": "base64"
  }  
}
<!--NeedCopy-->

Where, the “source” attribute’s value, is the base64 encoding of the contents of your StyleBook file. You can paste the YAML contents of your StyleBook file in an online tool, for example, https://www.browserling.com/tools/file-to-base64 to obtain the base64 string that you can then use as a value for the “source” attribute above.

Using this API call, you can also upload a compressed tarball file (.tgz file) containing multiple StyleBook files in one API operation. To do this, simply change the file name attribute to the .tgz file name and the value for the source attribute to the base64 encoding of the contents of your .tgz file.

After the API is run successfully in the tool you get the following response that indicates that the StyleBook has been imported into Citrix ADM.

200 OK
<!--NeedCopy-->

Response Body:

{

  "stylebook":
{

    "name": "example-lb",

    "namespace": "com.example.stylebook",

    "version": "1.0"

  }

}
<!--NeedCopy-->

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Use API to import custom StyleBooks

September 22, 2022

Contributed by:

R R C

September 22, 2022

Contributed by:

R R C

Use API to import custom StyleBooks

In this article