Cloud Management API 1.5

Cookbooks

Represents a given instance of a single cookbook.

Actions

index

Lists the Cookbooks available to this account.

The extended_designer view is only available to accounts with the designer permission.

URLs
GET /api/cookbooks
HTTP response code
200 OK
Content-type
application/vnd.rightscale.cookbook;type=collection

Required roles

Parameters

name required type values regexp blank? description
filter no Array * * no See below for valid filter parameters.
view no String default, extended, extended_designer * no Specifies how many attributes and/or expanded nested relationships to include.

Filters

name partial_match? description
name no Name of the Cookbooks to filter on.
namespace no Namespace of the Cookbooks to filter on.
repository_href no Repository href to filter on.
state no Status of the Cookbooks to filter on.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
[{
  "id": 1,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/1"},
    {"rel":"repository","href":"/api/repositories/1"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/1/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_1051892340"
},{
  "id": 2,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:44 +0000",
  "updated_at": "2018/10/16 16:04:44 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/2"},
    {"rel":"repository","href":"/api/repositories/2"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/2/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_2941756550"
}]
<?xml version="1.0" encoding="UTF-8"?>
<cookbooks>
  <cookbook>
    <id>1</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2018/10/16 16:04:42 +0000</created_at>
    <updated_at>2018/10/16 16:04:42 +0000</updated_at>
    <links>
      <link rel="self" href="/api/cookbooks/1"/>
      <link rel="repository" href="/api/repositories/1"/>
      <link rel="cookbook_attachments" href="/api/cookbooks/1/cookbook_attachments"/>
    </links>
    <actions>
      <action rel="freeze"/>
      <action rel="follow"/>
      <action rel="obsolete"/>
    </actions>
    <version>0.1.0</version>
    <name>cookbook_1051892340</name>
  </cookbook>
  <cookbook>
    <id>2</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2018/10/16 16:04:44 +0000</created_at>
    <updated_at>2018/10/16 16:04:44 +0000</updated_at>
    <links>
      <link rel="self" href="/api/cookbooks/2"/>
      <link rel="repository" href="/api/repositories/2"/>
      <link rel="cookbook_attachments" href="/api/cookbooks/2/cookbook_attachments"/>
    </links>
    <actions>
      <action rel="freeze"/>
      <action rel="follow"/>
      <action rel="obsolete"/>
    </actions>
    <version>0.1.0</version>
    <name>cookbook_2941756550</name>
  </cookbook>
</cookbooks>

Click on a format below to see an example response for the 'extended' view:

JSON XML
[{
  "id": 1,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/1"},
    {"rel":"repository","href":"/api/repositories/1"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/1/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_1051892340",
  "metadata": {
    "name": "cookbook_1051892340",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_1051892340::812546373": "desc",
      "cookbook_1051892340::233716450": "desc",
      "cookbook_1051892340::27684130": "desc",
      "cookbook_1051892340::2111584004": "desc",
      "cookbook_1051892340::1827990701": "desc"
    },
    "attributes": {
      "some/attribute": {
        "display_name": "Rubies to install",
        "description": "Which ruby versions to install",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": [
          "1.8.7",
          "1.9.2"
        ],
        "type": "array",
        "recipes": [
          "rvm::install_rubies"
        ]
      },
      "some/other_attribute": {
        "display_name": "RVM releases URL",
        "description": "URL to download RVM releases from",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "https://rvm.beginrescueend.com/releases/",
        "type": "string",
        "recipes": [

        ]
      },
      "yet/another_attribute": {
        "display_name": "RVM group",
        "description": "Group to run RVM as",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "root",
        "type": "string",
        "recipes": [

        ]
      }
    }
  }
},{
  "id": 2,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:44 +0000",
  "updated_at": "2018/10/16 16:04:44 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/2"},
    {"rel":"repository","href":"/api/repositories/2"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/2/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_2941756550",
  "metadata": {
    "name": "cookbook_2941756550",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2941756550::366062800": "desc",
      "cookbook_2941756550::590782839": "desc",
      "cookbook_2941756550::2712878848": "desc",
      "cookbook_2941756550::2839255085": "desc",
      "cookbook_2941756550::1854779793": "desc"
    },
    "attributes": {
      "some/attribute": {
        "display_name": "Rubies to install",
        "description": "Which ruby versions to install",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": [
          "1.8.7",
          "1.9.2"
        ],
        "type": "array",
        "recipes": [
          "rvm::install_rubies"
        ]
      },
      "some/other_attribute": {
        "display_name": "RVM releases URL",
        "description": "URL to download RVM releases from",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "https://rvm.beginrescueend.com/releases/",
        "type": "string",
        "recipes": [

        ]
      },
      "yet/another_attribute": {
        "display_name": "RVM group",
        "description": "Group to run RVM as",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "root",
        "type": "string",
        "recipes": [

        ]
      }
    }
  }
}]
<?xml version="1.0" encoding="UTF-8"?>
<cookbooks>
  <cookbook>
    <id>1</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2018/10/16 16:04:42 +0000</created_at>
    <updated_at>2018/10/16 16:04:42 +0000</updated_at>
    <links>
      <link rel="self" href="/api/cookbooks/1"/>
      <link rel="repository" href="/api/repositories/1"/>
      <link rel="cookbook_attachments" href="/api/cookbooks/1/cookbook_attachments"/>
    </links>
    <actions>
      <action rel="freeze"/>
      <action rel="follow"/>
      <action rel="obsolete"/>
    </actions>
    <version>0.1.0</version>
    <name>cookbook_1051892340</name>
    <metadata>{"name":"cookbook_1051892340","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_1051892340::812546373":"desc","cookbook_1051892340::233716450":"desc","cookbook_1051892340::27684130":"desc","cookbook_1051892340::2111584004":"desc","cookbook_1051892340::1827990701":"desc"},"attributes":{"some/attribute":{"display_name":"Rubies to install","description":"Which ruby versions to install","required":"optional","calculated":false,"choice":[],"default":["1.8.7","1.9.2"],"type":"array","recipes":["rvm::install_rubies"]},"some/other_attribute":{"display_name":"RVM releases URL","description":"URL to download RVM releases from","required":"optional","calculated":false,"choice":[],"default":"https://rvm.beginrescueend.com/releases/","type":"string","recipes":[]},"yet/another_attribute":{"display_name":"RVM group","description":"Group to run RVM as","required":"optional","calculated":false,"choice":[],"default":"root","type":"string","recipes":[]}}}</metadata>
  </cookbook>
  <cookbook>
    <id>2</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2018/10/16 16:04:44 +0000</created_at>
    <updated_at>2018/10/16 16:04:44 +0000</updated_at>
    <links>
      <link rel="self" href="/api/cookbooks/2"/>
      <link rel="repository" href="/api/repositories/2"/>
      <link rel="cookbook_attachments" href="/api/cookbooks/2/cookbook_attachments"/>
    </links>
    <actions>
      <action rel="freeze"/>
      <action rel="follow"/>
      <action rel="obsolete"/>
    </actions>
    <version>0.1.0</version>
    <name>cookbook_2941756550</name>
    <metadata>{"name":"cookbook_2941756550","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2941756550::366062800":"desc","cookbook_2941756550::590782839":"desc","cookbook_2941756550::2712878848":"desc","cookbook_2941756550::2839255085":"desc","cookbook_2941756550::1854779793":"desc"},"attributes":{"some/attribute":{"display_name":"Rubies to install","description":"Which ruby versions to install","required":"optional","calculated":false,"choice":[],"default":["1.8.7","1.9.2"],"type":"array","recipes":["rvm::install_rubies"]},"some/other_attribute":{"display_name":"RVM releases URL","description":"URL to download RVM releases from","required":"optional","calculated":false,"choice":[],"default":"https://rvm.beginrescueend.com/releases/","type":"string","recipes":[]},"yet/another_attribute":{"display_name":"RVM group","description":"Group to run RVM as","required":"optional","calculated":false,"choice":[],"default":"root","type":"string","recipes":[]}}}</metadata>
  </cookbook>
</cookbooks>

Click on a format below to see an example response for the 'extended_designer' view:

JSON XML
[{
  "id": 1,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/1"},
    {"rel":"repository","href":"/api/repositories/1"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/1/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_1051892340",
  "metadata": {
    "name": "cookbook_1051892340",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_1051892340::812546373": "desc",
      "cookbook_1051892340::233716450": "desc",
      "cookbook_1051892340::27684130": "desc",
      "cookbook_1051892340::2111584004": "desc",
      "cookbook_1051892340::1827990701": "desc"
    },
    "attributes": {
      "some/attribute": {
        "display_name": "Rubies to install",
        "description": "Which ruby versions to install",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": [
          "1.8.7",
          "1.9.2"
        ],
        "type": "array",
        "recipes": [
          "rvm::install_rubies"
        ]
      },
      "some/other_attribute": {
        "display_name": "RVM releases URL",
        "description": "URL to download RVM releases from",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "https://rvm.beginrescueend.com/releases/",
        "type": "string",
        "recipes": [

        ]
      },
      "yet/another_attribute": {
        "display_name": "RVM group",
        "description": "Group to run RVM as",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "root",
        "type": "string",
        "recipes": [

        ]
      }
    }
  },
  "download_url": "https://island-mirror-fixture.dev/cookbooks/6d96fe9de3bffaad?md5=6d96fe9de3bffaad&expiration=1539708586&signature=KSfc1znMlepbxmtI2tptaJyPw8IQYhq27X9WrwA7INutJtdZt0segD6AvsoX%0AADbylSnH6puCdv6hmqMfBEje7AS8z%2FY4qSjS9oOngpV0IeJSQyPlSLd49pvO%0AW8hr8enLG5kLw%2B715YgjBc9Kjq1%2BNSWg%2BRu%2BQG0B19FY9QbeuMs%3D%0A&signer=dev&filename=cookbook_1051892340_0.1.0_6d96fe9de3bffaad.tar"
},{
  "id": 2,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:44 +0000",
  "updated_at": "2018/10/16 16:04:44 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/2"},
    {"rel":"repository","href":"/api/repositories/2"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/2/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_2941756550",
  "metadata": {
    "name": "cookbook_2941756550",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2941756550::366062800": "desc",
      "cookbook_2941756550::590782839": "desc",
      "cookbook_2941756550::2712878848": "desc",
      "cookbook_2941756550::2839255085": "desc",
      "cookbook_2941756550::1854779793": "desc"
    },
    "attributes": {
      "some/attribute": {
        "display_name": "Rubies to install",
        "description": "Which ruby versions to install",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": [
          "1.8.7",
          "1.9.2"
        ],
        "type": "array",
        "recipes": [
          "rvm::install_rubies"
        ]
      },
      "some/other_attribute": {
        "display_name": "RVM releases URL",
        "description": "URL to download RVM releases from",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "https://rvm.beginrescueend.com/releases/",
        "type": "string",
        "recipes": [

        ]
      },
      "yet/another_attribute": {
        "display_name": "RVM group",
        "description": "Group to run RVM as",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "root",
        "type": "string",
        "recipes": [

        ]
      }
    }
  },
  "download_url": "https://island-mirror-fixture.dev/cookbooks/30d31674a32173b1?md5=30d31674a32173b1&expiration=1539708586&signature=Fv968llhWOOaYjobu%2BR%2BkI%2FAfUG76ZPVVzlTI1F6I%2BzHgW%2BHh7DthTMljAzJ%0AxDR7elLpiJDpX%2BCIqoWUWeUzbNAZ5qsXL2X%2FBR3w5atke2C%2FI6JFZJO%2FuRxx%0Aqj97Okx25lWD4PFh9DMnWpk1ulgka0XI%2F5Ca5mhRNlHf80dr6cY%3D%0A&signer=dev&filename=cookbook_2941756550_0.1.0_30d31674a32173b1.tar"
}]
<?xml version="1.0" encoding="UTF-8"?>
<cookbooks>
  <cookbook>
    <id>1</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2018/10/16 16:04:42 +0000</created_at>
    <updated_at>2018/10/16 16:04:42 +0000</updated_at>
    <links>
      <link rel="self" href="/api/cookbooks/1"/>
      <link rel="repository" href="/api/repositories/1"/>
      <link rel="cookbook_attachments" href="/api/cookbooks/1/cookbook_attachments"/>
    </links>
    <actions>
      <action rel="freeze"/>
      <action rel="follow"/>
      <action rel="obsolete"/>
    </actions>
    <version>0.1.0</version>
    <name>cookbook_1051892340</name>
    <metadata>{"name":"cookbook_1051892340","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_1051892340::812546373":"desc","cookbook_1051892340::233716450":"desc","cookbook_1051892340::27684130":"desc","cookbook_1051892340::2111584004":"desc","cookbook_1051892340::1827990701":"desc"},"attributes":{"some/attribute":{"display_name":"Rubies to install","description":"Which ruby versions to install","required":"optional","calculated":false,"choice":[],"default":["1.8.7","1.9.2"],"type":"array","recipes":["rvm::install_rubies"]},"some/other_attribute":{"display_name":"RVM releases URL","description":"URL to download RVM releases from","required":"optional","calculated":false,"choice":[],"default":"https://rvm.beginrescueend.com/releases/","type":"string","recipes":[]},"yet/another_attribute":{"display_name":"RVM group","description":"Group to run RVM as","required":"optional","calculated":false,"choice":[],"default":"root","type":"string","recipes":[]}}}</metadata>
    <download_url>https://island-mirror-fixture.dev/cookbooks/6d96fe9de3bffaad?md5=6d96fe9de3bffaad&amp;expiration=1539708586&amp;signature=KSfc1znMlepbxmtI2tptaJyPw8IQYhq27X9WrwA7INutJtdZt0segD6AvsoX%0AADbylSnH6puCdv6hmqMfBEje7AS8z%2FY4qSjS9oOngpV0IeJSQyPlSLd49pvO%0AW8hr8enLG5kLw%2B715YgjBc9Kjq1%2BNSWg%2BRu%2BQG0B19FY9QbeuMs%3D%0A&amp;signer=dev&amp;filename=cookbook_1051892340_0.1.0_6d96fe9de3bffaad.tar</download_url>
  </cookbook>
  <cookbook>
    <id>2</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2018/10/16 16:04:44 +0000</created_at>
    <updated_at>2018/10/16 16:04:44 +0000</updated_at>
    <links>
      <link rel="self" href="/api/cookbooks/2"/>
      <link rel="repository" href="/api/repositories/2"/>
      <link rel="cookbook_attachments" href="/api/cookbooks/2/cookbook_attachments"/>
    </links>
    <actions>
      <action rel="freeze"/>
      <action rel="follow"/>
      <action rel="obsolete"/>
    </actions>
    <version>0.1.0</version>
    <name>cookbook_2941756550</name>
    <metadata>{"name":"cookbook_2941756550","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2941756550::366062800":"desc","cookbook_2941756550::590782839":"desc","cookbook_2941756550::2712878848":"desc","cookbook_2941756550::2839255085":"desc","cookbook_2941756550::1854779793":"desc"},"attributes":{"some/attribute":{"display_name":"Rubies to install","description":"Which ruby versions to install","required":"optional","calculated":false,"choice":[],"default":["1.8.7","1.9.2"],"type":"array","recipes":["rvm::install_rubies"]},"some/other_attribute":{"display_name":"RVM releases URL","description":"URL to download RVM releases from","required":"optional","calculated":false,"choice":[],"default":"https://rvm.beginrescueend.com/releases/","type":"string","recipes":[]},"yet/another_attribute":{"display_name":"RVM group","description":"Group to run RVM as","required":"optional","calculated":false,"choice":[],"default":"root","type":"string","recipes":[]}}}</metadata>
    <download_url>https://island-mirror-fixture.dev/cookbooks/30d31674a32173b1?md5=30d31674a32173b1&amp;expiration=1539708586&amp;signature=Fv968llhWOOaYjobu%2BR%2BkI%2FAfUG76ZPVVzlTI1F6I%2BzHgW%2BHh7DthTMljAzJ%0AxDR7elLpiJDpX%2BCIqoWUWeUzbNAZ5qsXL2X%2FBR3w5atke2C%2FI6JFZJO%2FuRxx%0Aqj97Okx25lWD4PFh9DMnWpk1ulgka0XI%2F5Ca5mhRNlHf80dr6cY%3D%0A&amp;signer=dev&amp;filename=cookbook_2941756550_0.1.0_30d31674a32173b1.tar</download_url>
  </cookbook>
</cookbooks>

show

Show information about a single Cookbook.

The extended_designer view is only available to accounts with the designer permission.

URLs
GET /api/cookbooks/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.cookbook

Required roles

Parameters

name required type values regexp blank? description
view no String default, extended, extended_designer * no Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
{
  "id": 1,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/1"},
    {"rel":"repository","href":"/api/repositories/1"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/1/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_1051892340"
}
<?xml version="1.0" encoding="UTF-8"?>
<cookbook>
  <id>1</id>
  <namespace>alternate</namespace>
  <state>followed</state>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <links>
    <link rel="self" href="/api/cookbooks/1"/>
    <link rel="repository" href="/api/repositories/1"/>
    <link rel="cookbook_attachments" href="/api/cookbooks/1/cookbook_attachments"/>
  </links>
  <actions>
    <action rel="freeze"/>
    <action rel="follow"/>
    <action rel="obsolete"/>
  </actions>
  <version>0.1.0</version>
  <name>cookbook_1051892340</name>
</cookbook>

Click on a format below to see an example response for the 'extended' view:

JSON XML
{
  "id": 1,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/1"},
    {"rel":"repository","href":"/api/repositories/1"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/1/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_1051892340",
  "metadata": {
    "name": "cookbook_1051892340",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_1051892340::812546373": "desc",
      "cookbook_1051892340::233716450": "desc",
      "cookbook_1051892340::27684130": "desc",
      "cookbook_1051892340::2111584004": "desc",
      "cookbook_1051892340::1827990701": "desc"
    },
    "attributes": {
      "some/attribute": {
        "display_name": "Rubies to install",
        "description": "Which ruby versions to install",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": [
          "1.8.7",
          "1.9.2"
        ],
        "type": "array",
        "recipes": [
          "rvm::install_rubies"
        ]
      },
      "some/other_attribute": {
        "display_name": "RVM releases URL",
        "description": "URL to download RVM releases from",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "https://rvm.beginrescueend.com/releases/",
        "type": "string",
        "recipes": [

        ]
      },
      "yet/another_attribute": {
        "display_name": "RVM group",
        "description": "Group to run RVM as",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "root",
        "type": "string",
        "recipes": [

        ]
      }
    }
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<cookbook>
  <id>1</id>
  <namespace>alternate</namespace>
  <state>followed</state>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <links>
    <link rel="self" href="/api/cookbooks/1"/>
    <link rel="repository" href="/api/repositories/1"/>
    <link rel="cookbook_attachments" href="/api/cookbooks/1/cookbook_attachments"/>
  </links>
  <actions>
    <action rel="freeze"/>
    <action rel="follow"/>
    <action rel="obsolete"/>
  </actions>
  <version>0.1.0</version>
  <name>cookbook_1051892340</name>
  <metadata>{"name":"cookbook_1051892340","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_1051892340::812546373":"desc","cookbook_1051892340::233716450":"desc","cookbook_1051892340::27684130":"desc","cookbook_1051892340::2111584004":"desc","cookbook_1051892340::1827990701":"desc"},"attributes":{"some/attribute":{"display_name":"Rubies to install","description":"Which ruby versions to install","required":"optional","calculated":false,"choice":[],"default":["1.8.7","1.9.2"],"type":"array","recipes":["rvm::install_rubies"]},"some/other_attribute":{"display_name":"RVM releases URL","description":"URL to download RVM releases from","required":"optional","calculated":false,"choice":[],"default":"https://rvm.beginrescueend.com/releases/","type":"string","recipes":[]},"yet/another_attribute":{"display_name":"RVM group","description":"Group to run RVM as","required":"optional","calculated":false,"choice":[],"default":"root","type":"string","recipes":[]}}}</metadata>
</cookbook>

Click on a format below to see an example response for the 'extended_designer' view:

JSON XML
{
  "id": 1,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2018/10/16 16:04:42 +0000",
  "updated_at": "2018/10/16 16:04:42 +0000",
  "links": [
    {"rel":"self","href":"/api/cookbooks/1"},
    {"rel":"repository","href":"/api/repositories/1"},
    {"rel":"cookbook_attachments","href":"/api/cookbooks/1/cookbook_attachments"}
  ],
  "actions": [
    {
      "rel": "freeze"
    },
    {
      "rel": "follow"
    },
    {
      "rel": "obsolete"
    }
  ],
  "version": "0.1.0",
  "name": "cookbook_1051892340",
  "metadata": {
    "name": "cookbook_1051892340",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_1051892340::812546373": "desc",
      "cookbook_1051892340::233716450": "desc",
      "cookbook_1051892340::27684130": "desc",
      "cookbook_1051892340::2111584004": "desc",
      "cookbook_1051892340::1827990701": "desc"
    },
    "attributes": {
      "some/attribute": {
        "display_name": "Rubies to install",
        "description": "Which ruby versions to install",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": [
          "1.8.7",
          "1.9.2"
        ],
        "type": "array",
        "recipes": [
          "rvm::install_rubies"
        ]
      },
      "some/other_attribute": {
        "display_name": "RVM releases URL",
        "description": "URL to download RVM releases from",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "https://rvm.beginrescueend.com/releases/",
        "type": "string",
        "recipes": [

        ]
      },
      "yet/another_attribute": {
        "display_name": "RVM group",
        "description": "Group to run RVM as",
        "required": "optional",
        "calculated": false,
        "choice": [

        ],
        "default": "root",
        "type": "string",
        "recipes": [

        ]
      }
    }
  },
  "download_url": "https://island-mirror-fixture.dev/cookbooks/6d96fe9de3bffaad?md5=6d96fe9de3bffaad&expiration=1539708586&signature=KSfc1znMlepbxmtI2tptaJyPw8IQYhq27X9WrwA7INutJtdZt0segD6AvsoX%0AADbylSnH6puCdv6hmqMfBEje7AS8z%2FY4qSjS9oOngpV0IeJSQyPlSLd49pvO%0AW8hr8enLG5kLw%2B715YgjBc9Kjq1%2BNSWg%2BRu%2BQG0B19FY9QbeuMs%3D%0A&signer=dev&filename=cookbook_1051892340_0.1.0_6d96fe9de3bffaad.tar"
}
<?xml version="1.0" encoding="UTF-8"?>
<cookbook>
  <id>1</id>
  <namespace>alternate</namespace>
  <state>followed</state>
  <created_at>2018/10/16 16:04:42 +0000</created_at>
  <updated_at>2018/10/16 16:04:42 +0000</updated_at>
  <links>
    <link rel="self" href="/api/cookbooks/1"/>
    <link rel="repository" href="/api/repositories/1"/>
    <link rel="cookbook_attachments" href="/api/cookbooks/1/cookbook_attachments"/>
  </links>
  <actions>
    <action rel="freeze"/>
    <action rel="follow"/>
    <action rel="obsolete"/>
  </actions>
  <version>0.1.0</version>
  <name>cookbook_1051892340</name>
  <metadata>{"name":"cookbook_1051892340","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_1051892340::812546373":"desc","cookbook_1051892340::233716450":"desc","cookbook_1051892340::27684130":"desc","cookbook_1051892340::2111584004":"desc","cookbook_1051892340::1827990701":"desc"},"attributes":{"some/attribute":{"display_name":"Rubies to install","description":"Which ruby versions to install","required":"optional","calculated":false,"choice":[],"default":["1.8.7","1.9.2"],"type":"array","recipes":["rvm::install_rubies"]},"some/other_attribute":{"display_name":"RVM releases URL","description":"URL to download RVM releases from","required":"optional","calculated":false,"choice":[],"default":"https://rvm.beginrescueend.com/releases/","type":"string","recipes":[]},"yet/another_attribute":{"display_name":"RVM group","description":"Group to run RVM as","required":"optional","calculated":false,"choice":[],"default":"root","type":"string","recipes":[]}}}</metadata>
  <download_url>https://island-mirror-fixture.dev/cookbooks/6d96fe9de3bffaad?md5=6d96fe9de3bffaad&amp;expiration=1539708586&amp;signature=KSfc1znMlepbxmtI2tptaJyPw8IQYhq27X9WrwA7INutJtdZt0segD6AvsoX%0AADbylSnH6puCdv6hmqMfBEje7AS8z%2FY4qSjS9oOngpV0IeJSQyPlSLd49pvO%0AW8hr8enLG5kLw%2B715YgjBc9Kjq1%2BNSWg%2BRu%2BQG0B19FY9QbeuMs%3D%0A&amp;signer=dev&amp;filename=cookbook_1051892340_0.1.0_6d96fe9de3bffaad.tar</download_url>
</cookbook>

destroy

Destroys a Cookbook. Only available for cookbooks that have no Cookbook Attachments.

URLs
DELETE /api/cookbooks/:id
HTTP response code
204 No Content

Required roles

follow

Follows (or unfollows) a Cookbook. Only available for cookbooks that are in the Alternate namespace.

URLs
POST /api/cookbooks/:id/follow
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
value yes String true, false * no Indicates if this action should follow (true) or unfollow (false) a Cookbook.

freeze

Freezes (or unfreezes) a Cookbook. Only available for cookbooks that are in the Primary namespace.

URLs
POST /api/cookbooks/:id/freeze
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
value yes String true, false * no Indicates if this action should freeze (true) or unfreeze (false) a Cookbook.

obsolete

Marks a Cookbook as obsolete (or un-obsolete).

URLs
POST /api/cookbooks/:id/obsolete
HTTP response code
204 No Content

Required roles

Parameters

name required type values regexp blank? description
value yes String true, false * no Indicates if this action should obsolete (true) or un-obsolete (false) a Cookbook.