Develop > API calls > Container APIs > List existing containers

List existing containers

Returns a list of all existing containers.

URI Method Parameters Returns
http://[host]:[port]/csa/api/container GET
  • type - Specifies the type of containers to return.
  • start-index - Specifies the offset of the first entry to be included in the page.
  • page-size - Specifies the page size.
  • sort - Name of field to be used for ordering. Optionally followed by colon and "ascending" or "descending."
  • after - Filters members to those modified on or after the specified timestamp. This parameter uses the SimpleDateFormat ("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'") in UTC.
  • before - Filters members to those modified before this timestamp. Uses the SimpleDateFormat ("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'") in UTC.

200 - successful
403 -not authorized
404 - no containers found

Example

The following URL was sent:

https://localhost:8444/csa/api/container

The following JSON was returned:

{ "@total_results": 1, "@start_index": 0, "@items_per_page": 1, "@self": "/csa/api/container/", "@type": "urn:x-hp:2012:software:cloud:data_model:metamodel:collection", "members": [ { "@self": "/csa/api/container/72A82AD399D64A1FADABE348AA59DB90", "@type": "urn:x-hp:2012:software:cloud:data_model:metamodel", "global_id": "72A82AD399D64A1FADABE348AA59DB90", "name": "HP CSA", "description": "HP Cloud Service Automation Default Component Catalog", "icon": "/csa/api/blobstore/HP_Blue_RGB_150_MN.png?tag=library", "ext": { "csa_name_key": "HP_CSA", "csa_critical_system_object": false, "csa_artifact_container_type": "COMPONENT_PALETTE_SEQUENCE_BASED" }, "tags": [] } ], "@modified": null }