Get Namespace

Get Namespace

Use this endpoint to fetch a Namespace
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER

Request
URI
GET
https://{api_host}/provider/namespaces/{id}
COPY
Path Parameters
string
id
Required

ID of the Namespace

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NamespaceDto of type(s) application/vnd.vmware.dms-v1+json 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "environment": {
        "id": "string",
        "name": "string"
    },
    "localStorages": [
        {
            "id": "string",
            "name": "string",
            "isDefault": false
        }
    ],
    "cloudStorages": [
        {
            "id": "string",
            "name": "string",
            "isDefault": false
        }
    ],
    "datastores": [
        {
            "id": "string",
            "name": "string",
            "moId": "string",
            "isDefault": false
        }
    ],
    "appNetworks": [
        {
            "id": "string",
            "name": "string",
            "moId": "string",
            "isDefault": false
        }
    ],
    "organisations": [
        {
            "id": "string",
            "name": "string",
            "isPublished": false,
            "databaseCount": 0
        }
    ],
    "status": "string",
    "runtimeInfo": [
        {
            "id": "string",
            "namespaceId": "string",
            "alertType": "string",
            "alertLevel": "string",
            "alertTime": "string"
        }
    ],
    "databaseCount": 0,
    "lastUpdatedTime": "string",
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

id

string
name
Required

name

string
description
Optional

description

NamespaceObjectRef
environment
Required

environment

array of NamespaceObjectRefWithDefault
localStorages
Required

localStorages

array of NamespaceObjectRefWithDefault
cloudStorages
Required

cloudStorages

array of NamespaceVcObjectRefWithDefault
datastores
Required

datastores

array of NamespaceVcObjectRefWithDefault
appNetworks
Required

appNetworks

array of NamespaceOrgObjectRef
organisations
Required

organisations

string
status
Required

status

Possible values are : INIT, ONLINE, ERROR, WARNING,
array of NamespaceRuntimeInfoDto
runtimeInfo
Required

runtimeInfo

integer As int32 As int32
databaseCount
Optional

databaseCount

string As date-time As date-time
lastUpdatedTime
Optional

lastUpdatedTime

array of Link
links
Optional

links


400

Bad Request

Operation doesn't return any data structure

On This Page
Namespace Information Operations
PUT
Add Organisation To Namespace
POST
Create Namespace
DELETE
Delete Namespace
PUT
Edit Namespace
GET
Get Datastore Storage Info By Namespace Id
GET
Get Flagged Namespace Alert Types
GET
Get Namespace
GET
Get Namespace Active Backup Storage Usage
GET
Get Namespace Active Resources
GET
List All Namespace Runtime Info Histories
GET
List All Namespaces
PUT
Publish Namespace To Organisation
DELETE
Remove Organisation From Namespace
DELETE
Un Publish Namespace From Organisation
PUT
Update Namespace Alert Type As Verified