Cloud Management API 1.5

MediaTypes:

AccountGroup | Account | AlertSpec | Alert | AuditEntry | Backup | CloudAccount | Cloud | CookbookAttachment | Cookbook | Credential | Datacenter | Deployment | IdentityProvider | Image | Input | InstanceType | Instance | IpAddressBinding | IpAddress | MonitoringMetric | MonitoringMetricData | MultiCloudImageMatcher | MultiCloudImageSetting | MultiCloudImage | NetworkGateway | NetworkOptionGroupAttachment | NetworkOptionGroup | Network | Permission | PlacementGroup | Preference | PublicationLineage | Publication | RecurringVolumeAttachment | Repository | RepositoryAsset | ResourceGroup | RightScriptAttachment | RightScript | RouteTable | Route | RunnableBinding | SecurityGroupRule | SecurityGroup | ServerArray | ServerTemplateMultiCloudImage | ServerTemplate | Server | Session | SshKey | Subnet | ResourceTag | Task | User | VolumeAttachment | VolumeSnapshot | VolumeType | Volume |

Resources:

AccountGroups | Accounts | AlertSpecs | Alerts | AuditEntries | Backups | ChildAccounts | CloudAccounts | Clouds | CookbookAttachments | Cookbooks | Credentials | Datacenters | Deployments | HealthCheck | IdentityProviders | Images | Inputs | InstanceTypes | Instances | IpAddressBindings | IpAddresses | MonitoringMetrics | MultiCloudImageMatchers | MultiCloudImageSettings | MultiCloudImages | NetworkGateways | NetworkOptionGroupAttachments | NetworkOptionGroups | Networks | Oauth2 | Permissions | PlacementGroups | Preferences | PublicationLineages | Publications | RecurringVolumeAttachments | Repositories | RepositoryAssets | ResourceGroups | RightScriptAttachments | RightScripts | RouteTables | Routes | RunnableBindings | SecurityGroupRules | SecurityGroups | ServerArrays | ServerTemplateMultiCloudImages | ServerTemplates | Servers | Sessions | SshKeys | Subnets | Tags | Tasks | UserDatas | Users | VolumeAttachments | VolumeSnapshots | VolumeTypes | Volumes |

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": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +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_2286709245"
},{
  "id": 2,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2023/10/09 11:06:03 +0000",
  "updated_at": "2023/10/09 11:06:03 +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_2682570683"
}]
<?xml version="1.0" encoding="UTF-8"?>
<cookbooks>
  <cookbook>
    <id>1</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +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_2286709245</name>
  </cookbook>
  <cookbook>
    <id>2</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2023/10/09 11:06:03 +0000</created_at>
    <updated_at>2023/10/09 11:06:03 +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_2682570683</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": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +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_2286709245",
  "metadata": {
    "name": "cookbook_2286709245",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2286709245::1354109241": "desc",
      "cookbook_2286709245::2564613933": "desc",
      "cookbook_2286709245::3581088844": "desc",
      "cookbook_2286709245::705536621": "desc",
      "cookbook_2286709245::2436807142": "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": "2023/10/09 11:06:03 +0000",
  "updated_at": "2023/10/09 11:06:03 +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_2682570683",
  "metadata": {
    "name": "cookbook_2682570683",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2682570683::3773213797": "desc",
      "cookbook_2682570683::177855160": "desc",
      "cookbook_2682570683::3668747635": "desc",
      "cookbook_2682570683::2791816619": "desc",
      "cookbook_2682570683::2913658786": "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>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +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_2286709245</name>
    <metadata>{"name":"cookbook_2286709245","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2286709245::1354109241":"desc","cookbook_2286709245::2564613933":"desc","cookbook_2286709245::3581088844":"desc","cookbook_2286709245::705536621":"desc","cookbook_2286709245::2436807142":"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>2023/10/09 11:06:03 +0000</created_at>
    <updated_at>2023/10/09 11:06:03 +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_2682570683</name>
    <metadata>{"name":"cookbook_2682570683","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2682570683::3773213797":"desc","cookbook_2682570683::177855160":"desc","cookbook_2682570683::3668747635":"desc","cookbook_2682570683::2791816619":"desc","cookbook_2682570683::2913658786":"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": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +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_2286709245",
  "metadata": {
    "name": "cookbook_2286709245",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2286709245::1354109241": "desc",
      "cookbook_2286709245::2564613933": "desc",
      "cookbook_2286709245::3581088844": "desc",
      "cookbook_2286709245::705536621": "desc",
      "cookbook_2286709245::2436807142": "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/9b80567ba5077ef3?md5=9b80567ba5077ef3&expiration=1696852266&signature=VF2SG4xNxKeKv1gh%2BhVHgUQI970ynIC5k%2Brvaf5l2PZibR2%2B%2FcvdY4mwN%2FH7%0AzpZ9IWCtcFCrQvVtwAKE7dS%2B1EjOHEg76CUnCTHHPSWvuS0swNPG9hZPkYOo%0AUlgHkVdDzstwwztkFkYhdH5t0H37uXxCtWszwvaNKDK4KTb7NSQ%3D%0A&signer=dev&filename=cookbook_2286709245_0.1.0_9b80567ba5077ef3.tar"
},{
  "id": 2,
  "namespace": "alternate",
  "state": "followed",
  "created_at": "2023/10/09 11:06:03 +0000",
  "updated_at": "2023/10/09 11:06:03 +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_2682570683",
  "metadata": {
    "name": "cookbook_2682570683",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2682570683::3773213797": "desc",
      "cookbook_2682570683::177855160": "desc",
      "cookbook_2682570683::3668747635": "desc",
      "cookbook_2682570683::2791816619": "desc",
      "cookbook_2682570683::2913658786": "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/1e675d5e148b6fe9?md5=1e675d5e148b6fe9&expiration=1696852266&signature=kzc9HMxFG1lJZBlbdTAi4W%2BIgQBeUc8bDABxmOnkKM7A0zUuEjyEuZaq2lOx%0AL65v9OCUlSw%2F%2F1TOQrmRFmuVmF4FLkO6yCI38oXZi9ZvbSkzcvtidYO3q%2Bvo%0ARB84gBn%2FdxfmggTGp5R5q3GfeRHFzLQppvA%2BAfenY%2FhqJPx1tMs%3D%0A&signer=dev&filename=cookbook_2682570683_0.1.0_1e675d5e148b6fe9.tar"
}]
<?xml version="1.0" encoding="UTF-8"?>
<cookbooks>
  <cookbook>
    <id>1</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2023/10/09 11:06:02 +0000</created_at>
    <updated_at>2023/10/09 11:06:02 +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_2286709245</name>
    <metadata>{"name":"cookbook_2286709245","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2286709245::1354109241":"desc","cookbook_2286709245::2564613933":"desc","cookbook_2286709245::3581088844":"desc","cookbook_2286709245::705536621":"desc","cookbook_2286709245::2436807142":"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/9b80567ba5077ef3?md5=9b80567ba5077ef3&amp;expiration=1696852266&amp;signature=VF2SG4xNxKeKv1gh%2BhVHgUQI970ynIC5k%2Brvaf5l2PZibR2%2B%2FcvdY4mwN%2FH7%0AzpZ9IWCtcFCrQvVtwAKE7dS%2B1EjOHEg76CUnCTHHPSWvuS0swNPG9hZPkYOo%0AUlgHkVdDzstwwztkFkYhdH5t0H37uXxCtWszwvaNKDK4KTb7NSQ%3D%0A&amp;signer=dev&amp;filename=cookbook_2286709245_0.1.0_9b80567ba5077ef3.tar</download_url>
  </cookbook>
  <cookbook>
    <id>2</id>
    <namespace>alternate</namespace>
    <state>followed</state>
    <created_at>2023/10/09 11:06:03 +0000</created_at>
    <updated_at>2023/10/09 11:06:03 +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_2682570683</name>
    <metadata>{"name":"cookbook_2682570683","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2682570683::3773213797":"desc","cookbook_2682570683::177855160":"desc","cookbook_2682570683::3668747635":"desc","cookbook_2682570683::2791816619":"desc","cookbook_2682570683::2913658786":"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/1e675d5e148b6fe9?md5=1e675d5e148b6fe9&amp;expiration=1696852266&amp;signature=kzc9HMxFG1lJZBlbdTAi4W%2BIgQBeUc8bDABxmOnkKM7A0zUuEjyEuZaq2lOx%0AL65v9OCUlSw%2F%2F1TOQrmRFmuVmF4FLkO6yCI38oXZi9ZvbSkzcvtidYO3q%2Bvo%0ARB84gBn%2FdxfmggTGp5R5q3GfeRHFzLQppvA%2BAfenY%2FhqJPx1tMs%3D%0A&amp;signer=dev&amp;filename=cookbook_2682570683_0.1.0_1e675d5e148b6fe9.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": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +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_2286709245"
}
<?xml version="1.0" encoding="UTF-8"?>
<cookbook>
  <id>1</id>
  <namespace>alternate</namespace>
  <state>followed</state>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +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_2286709245</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": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +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_2286709245",
  "metadata": {
    "name": "cookbook_2286709245",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2286709245::1354109241": "desc",
      "cookbook_2286709245::2564613933": "desc",
      "cookbook_2286709245::3581088844": "desc",
      "cookbook_2286709245::705536621": "desc",
      "cookbook_2286709245::2436807142": "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>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +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_2286709245</name>
  <metadata>{"name":"cookbook_2286709245","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2286709245::1354109241":"desc","cookbook_2286709245::2564613933":"desc","cookbook_2286709245::3581088844":"desc","cookbook_2286709245::705536621":"desc","cookbook_2286709245::2436807142":"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": "2023/10/09 11:06:02 +0000",
  "updated_at": "2023/10/09 11:06:02 +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_2286709245",
  "metadata": {
    "name": "cookbook_2286709245",
    "dependencies": {
    },
    "maintainer": "Someone",
    "maintainer_email": "someone@rightscale.com",
    "license": "GPLv3",
    "suggestions": {
    },
    "platforms": {
    },
    "long_description": "",
    "version": "0.1.0",
    "recommendations": {
    },
    "conflicting": {
    },
    "recipes": {
      "cookbook_2286709245::1354109241": "desc",
      "cookbook_2286709245::2564613933": "desc",
      "cookbook_2286709245::3581088844": "desc",
      "cookbook_2286709245::705536621": "desc",
      "cookbook_2286709245::2436807142": "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/9b80567ba5077ef3?md5=9b80567ba5077ef3&expiration=1696852266&signature=VF2SG4xNxKeKv1gh%2BhVHgUQI970ynIC5k%2Brvaf5l2PZibR2%2B%2FcvdY4mwN%2FH7%0AzpZ9IWCtcFCrQvVtwAKE7dS%2B1EjOHEg76CUnCTHHPSWvuS0swNPG9hZPkYOo%0AUlgHkVdDzstwwztkFkYhdH5t0H37uXxCtWszwvaNKDK4KTb7NSQ%3D%0A&signer=dev&filename=cookbook_2286709245_0.1.0_9b80567ba5077ef3.tar"
}
<?xml version="1.0" encoding="UTF-8"?>
<cookbook>
  <id>1</id>
  <namespace>alternate</namespace>
  <state>followed</state>
  <created_at>2023/10/09 11:06:02 +0000</created_at>
  <updated_at>2023/10/09 11:06:02 +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_2286709245</name>
  <metadata>{"name":"cookbook_2286709245","dependencies":{},"maintainer":"Someone","maintainer_email":"someone@rightscale.com","license":"GPLv3","suggestions":{},"platforms":{},"long_description":"","version":"0.1.0","recommendations":{},"conflicting":{},"recipes":{"cookbook_2286709245::1354109241":"desc","cookbook_2286709245::2564613933":"desc","cookbook_2286709245::3581088844":"desc","cookbook_2286709245::705536621":"desc","cookbook_2286709245::2436807142":"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/9b80567ba5077ef3?md5=9b80567ba5077ef3&amp;expiration=1696852266&amp;signature=VF2SG4xNxKeKv1gh%2BhVHgUQI970ynIC5k%2Brvaf5l2PZibR2%2B%2FcvdY4mwN%2FH7%0AzpZ9IWCtcFCrQvVtwAKE7dS%2B1EjOHEg76CUnCTHHPSWvuS0swNPG9hZPkYOo%0AUlgHkVdDzstwwztkFkYhdH5t0H37uXxCtWszwvaNKDK4KTb7NSQ%3D%0A&amp;signer=dev&amp;filename=cookbook_2286709245_0.1.0_9b80567ba5077ef3.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.

For more information on API 1.5, including examples, please see the API 1.5 topic on our support site.

Generated: 2023-10-09 11:06:06 UTC