Configuration Template Manager API

REST Resources

/api/space/config-template-management/config-templates/{id}

The following operations are supported on this resource:

GET - Get a configuration template
PUT - Update or replace a configuration template
PATCH - Patche a configuration template
DELETE - Delete a configuration template

GET /config-templates/{id}

Version 3

This API gets a single configuration template.

Sample Usage

GET /config-templates/{id}

Parameters:

Name Type URI Type Description Required

id Integer Path The ID of the configuration template. Y

Accept Headers:
application/vnd.net.juniper.space.config-template-management.config-template+xml;version=3
application/vnd.net.juniper.space.config-template-management.config-template+json;version=3

XML
JSON

Sample Output XML:

<config-template

     	 href="/api/space/config-template-management/config-templates/{id}" uri="/api/space/config-template-management/config-templates/{id}">

     	 <id>Integer</id>

     	 <name>String</name>

     	 <description>String</description>

     	 <deployed-tempalte-ver>Integer</deployed-tempalte-ver>

     	 <versions total="Integer">

           	<version>Integer</version>

     	 </versions>

     	 <config-type>CONFIG_TEMPLATE</config-type>

     	 <state>String</state>

     	 <os-version>String</os-version>

     	 <current-version>Integer</current-version>

     	 <device-family>String</device-family>

     	 <last-updated-by>String</last-updated-by>

     	 <last-update-time-string>String</last-update-time-string>

     	 <template-deployment-status>String</template-deployment-status>

     	 <config-template-definition

           	href="/api/space/config-template-management/config-template-definitions/{id}" uri="/api/space/config-template-management/config-templates/{id}">

           	<id>Integer</id>

           	<name>String</name>

           	<configuration href="/api/space/config-template-management/config-template-definitions/{id}/configuration"/>

     	 </config-template-definition>

     	 <domain-name>String</domain-name>

     	 <domain-id>Integer</domain-id>

     	 <domain href="/api/space/domain-management/domains/{domainId}"/>

     	 <configuration href="/api/space/config-template-management/config-templates/{id}/configuration"/>

     	 <exec-deploy href="/api/space/config-template-management/config-templates/{id}/exec-deploy"/>

     	 <exec-undeploy href="/api/space/config-template-management/config-templates/{id}/exec-undeploy"/>

     	 <exec-audit href="/api/space/config-template-management/config-templates/{id}/exec-audit"/>

     	 <device-associations href="/api/space/config-template-management/config-templates/{id}/device-associations"/>

     	 <exec-publish href="/api/space/config-template-management/config-templates/{id}/exec-publish"/>

     	 <versions href="/api/space/config-template-management/config-templates/{id}/versions"/>

     	 <clone href="/api/space/config-template-management/config-templates/{id}/clone"/>

 </config-template>

Sample Output JSON:

{

   	"config-template" : {

     	"@href" : "/api/space/config-template-management/config-templates/{id}",

     	"@uri" : "/api/space/config-template-management/config-templates/{id}",

     	"id" : "Integer" ,

     	"name" : "String" ,

     	"description" : "String" ,

     	"deployed-tempalte-ver" : "Integer",

     	"versions" : [ 

          {

         	"@total" : "Integer" ,

         	"version" : "Integer"

       	} , 

          {

         	"@href" : "/api/space/config-template-management/config-templates/{id}/versions"

          }

     	 ] ,

     	"config-type" : "CONFIG_TEMPLATE" ,

     	"state" : "String" ,

     	"os-version" : "String" ,

     	"current-version" : "Integer" ,

     	"device-family" : "String" ,

     	"last-updated-by" : "String" ,

     	"last-update-time-string" : "String" ,

     	"template-deployment-status" : "String" ,

     	"config-template-definition" : {

       	"@href" : "/api/space/config-template-management/config-template-definitions/{id}" ,

       	"@uri" : "/api/space/config-template-management/config-templates/{id}" ,

       	"id" : "Integer" ,

       	"name" : "String" ,

       	"configuration" : {

         	"@href" : "/api/space/config-template-management/config-template-definitions/{id}/configuration"

       	}

     	} ,

     	"domain-name" : "String" ,

     	"domain-id" : "Integer" ,

     	"domain" : {

       	"@href" : "/api/space/domain-management/domains/{domainId}"

     	} ,

     	"configuration" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/configuration"

     	} ,

     	"exec-deploy" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/exec-deploy"

     	} ,

     	"exec-undeploy" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/exec-undeploy"

     	} ,

     	"exec-audit" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/exec-audit"

     	} ,

     	"device-associations" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/device-associations"

     	} ,

     	"exec-publish" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/exec-publish"

     	} ,

     	"clone" : {

       	"@href" : "/api/space/config-template-management/config-templates/{id}/clone"

     	}

   	}

 }

Access Control

The following capabilities are required to access this API: ManageTemplates

PUT /config-templates/{id}

Version 1

This API updates or replaces a configuration template.

Sample Usage

PUT /config-templates/{id}

Parameters:

Name Type URI Type Description Required

id Integer Path The ID of the configuration template. Y

Content-Type Headers:
application/vnd.net.juniper.space.config-template-management.config-template+xml;version=1;charset=UTF-8
application/vnd.net.juniper.space.config-template-management.config-template+json;version=1;charset=UTF-8

Accept Headers:
application/vnd.net.juniper.space.config-template-management.config-template+xml;version=1
application/vnd.net.juniper.space.config-template-management.config-template+json;version=1

XML
JSON

Sample Input XML:

<config-template>

         <name>String</name>

         <description>String</description>

 </config-template>

Sample Output XML:

<config-template

         href="/api/space/config-template-management/config-templates/{id}" uri="/api/space/config-template-management/config-templates/{id}">

         <id>Integer</id>

         <name>String</name>

         <description>String</description>

         <config-type>CONFIG_TEMPLATE</config-type>

         <state>String</state>

         <os-version>String</os-version>

         <current-version>Integer</current-version>

         <device-family>String</device-family>

         <last-updated-by>String</last-updated-by>

         <last-update-time-string>String</last-update-time-string>

         <template-deployment-status>String</template-deployment-status>

         <config-template-definition

              href="/api/space/config-template-management/config-template-definitions/{id}" uri="/api/space/config-template-management/config-templates/{id}">

              <id>Integer</id>

              <name>String</name>

         </config-template-definition>

         <domain-name>String</domain-name>

         <domain-id>Integer</domain-id>

 </config-template>

Sample Input JSON:

{

      "config-template" : {

        "name" : "String" ,

        "description" : "String" 

      }

 }

Sample Output JSON:

{

      "config-template" : {

        "@href" : "/api/space/config-template-management/config-templates/{id}" ,

        "@uri" : "/api/space/config-template-management/config-templates/{id}" ,

        "id" : "Integer" ,

        "name" : "String" ,

        "description" : "String" ,

        "config-type" : "CONFIG_TEMPLATE" ,

        "state" : "String" ,

        "os-version" : "String" ,

        "current-version" : "Integer" ,

        "device-family" : "String" ,

        "last-updated-by" : "String" ,

        "last-update-time-string" : "String" ,

        "template-deployment-status" : "String" ,

        "config-template-definition" : {

          "@href" : "/api/space/config-template-management/config-template-definitions/{id}" ,

          "@uri" : "/api/space/config-template-management/config-templates/{id}" ,

          "id" : "Integer" ,

          "name" : "String"

        } ,

        "domain-name" : "String" ,

        "domain-id" : "Integer"

      }

 }

Access Control

The following capabilities are required to access this API: ModifyTemplate

PATCH /config-templates/{id}

Version 1

This API patch a single configuration template.

Sample Usage

PATCH /config-templates/{id}

Parameters:

Name Type URI Type Description Required

id Integer Path The ID of the configuration template. Y

Content-Type Headers:
application/vnd.net.juniper.space.config-template-management.config-template_patch+xml;version=1;charset=UTF-8

Accept Headers:
application/vnd.net.juniper.space.config-template-management.config-template+xml;version=1

XML
JSON

Sample Patch XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

 <diff>

      <!--What you see below are just samples of patch operations that may be performed on this DTO.-->

      <!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->

      <replace sel="config-template/name">

        <name>String</name>

      </replace>

      <replace sel="config-template/description">

        <description>String</description>

      </replace>

      <replace sel="config-template/domain-name">

        <domain-name>String</domain-name>

      </replace>

      <replace sel="config-template/domain-id">

        <domain-id>Integer</domain-id>

      </replace>

 </diff>

Sample Output XML:

<config-template

         href="/api/space/config-template-management/config-templates/{id}" uri="/api/space/config-template-management/config-templates/{id}">

         <id>Integer</id>

         <name>String</name>

         <description>String</description>

         <config-type>CONFIG_TEMPLATE</config-type>

         <state>String</state>

         <os-version>String</os-version>

         <current-version>Integer</current-version>

         <device-family>String</device-family>

         <last-updated-by>String</last-updated-by>

         <last-update-time-string>String</last-update-time-string>

         <template-deployment-status>String</template-deployment-status>

         <config-template-definition

              href="/api/space/config-template-management/config-template-definitions/{id}" uri="/api/space/config-template-management/config-templates/{id}">

              <id>Integer</id>

              <name>String</name>

              <configuration href="/api/space/config-template-management/config-template-definitions/{id}/configuration"/>

         </config-template-definition>

         <domain-name>String</domain-name>

         <domain-id>Integer</domain-id>

         <domain href="/api/space/domain-management/domains/{domainId}"/>

         <configuration href="/api/space/config-template-management/config-templates/{id}/configuration"/>

         <exec-deploy href="/api/space/config-template-management/config-templates/{id}/exec-deploy"/>

         <exec-undeploy href="/api/space/config-template-management/config-templates/{id}/exec-undeploy"/>

         <exec-audit href="/api/space/config-template-management/config-templates/{id}/exec-audit"/>

         <device-associations href="/api/space/config-template-management/config-templates/{id}/device-associations"/>

         <exec-publish href="/api/space/config-template-management/config-templates/{id}/exec-publish"/>

         <versions href="/api/space/config-template-management/config-templates/{id}/versions"/>

 </config-template>

Sample Output JSON:

{

      "config-template" : {

        "@href" : "/api/space/config-template-management/config-templates/{id}" ,

        "@uri" : "/api/space/config-template-management/config-templates/{id}" ,

        "id" : "Integer" ,

        "name" : "String" ,

        "description" : "String" ,

        "config-type" : "CONFIG_TEMPLATE" ,

        "state" : "String" ,

        "os-version" : "String" ,

        "current-version" : "Integer" ,

        "device-family" : "String" ,

        "last-updated-by" : "String" ,

        "last-update-time-string" : "String" ,

        "template-deployment-status" : "String" ,

        "config-template-definition" : {

          "@href" :

          "/api/space/config-template-management/config-template-definitions/{id}" ,

          "@uri" : "/api/space/config-template-management/config-templates/{id}" ,

          "id" : "Integer" ,

          "name" : "String" ,

          "configuration" : {

            "@href" :

            "/api/space/config-template-management/config-template-definitions/{id}/configuration"

          }

        } ,

        "domain-name" : "String" ,

        "domain-id" : "Integer" ,

        "domain" : {

          "@href" : "/api/space/domain-management/domains/{domainId}"

        } ,

        "configuration" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/configuration"

        } ,

        "exec-deploy" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/exec-deploy"

        } ,

        "exec-undeploy" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/exec-undeploy"

        } ,

        "exec-audit" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/exec-audit"

        } ,

        "device-associations" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/device-associations"

        } ,

        "exec-publish" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/exec-publish"

        } ,

        "versions" : {

          "@href" :

          "/api/space/config-template-management/config-templates/{id}/versions"

        }

      }

 }

Access Control

The following capabilities are required to access this API: ManageTemplates

DELETE /config-templates/{id}

Version 1

This API deletes a specified configuration template.

Sample Usage

DELETE /config-templates/{id}

Parameters:

Name Type URI Type Description Required

id Integer Path The ID of the configuration template. Y

Access Control

The following capabilities are required to access this API: DeleteTemplate

Name	Type	URI Type	Description	Required
id	Integer	Path	The ID of the configuration template.	Y