Cloud Enterprise Object Storage REST API

Search (SHIFT+S)

Create Base URL

POST /object/baseurl

Creates a Base URL with the given details.

Required Roles


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
name Name for this Base-URL String
base_url Base URL to be used String
is_namespace_in_host Set true if namespace is in host, false otherwise Boolean Valid Values:
  •  true
  •  false

Response Body

Newly created base url details.

Field Description Type Notes
baseurl Base URL String
namespace_in_host Flag indicating whether namespace is a part of the host Boolean
name Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
id Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
link Hyperlink to the details for this resource
creation_time Timestamp that shows when this resource was created in ECS DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
  •  Unix timestamp
inactive Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. Boolean Valid Values:
  •  true
  •  false
global Indicates whether the resource is global. Boolean Valid Values:
  •  true
  •  false
remote Indicates whether the resource is remote. Boolean Valid Values:
  •  true
  •  false
id ECS Id of the related object URI
link Hyperlink to the related object
internal Indicated whether the resource is an internal resource Boolean Valid Values:
  •  true
  •  false



Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
   <link href="/object/baseurl/urn:storageos:ObjectBaseUrl:d7bf4302-403c-4308-a8d7-073cbb38fbeb:"