Get Folder

Get Folder

Show vCenter folder details

Request

URI

GET

https://{api_host}/api/ni/entities/folders/{id}

COPY

Path Parameters

string

id

Required

The Entity ID of object requestion information on

Query Parameters

integer

time

Optional

Time in epoch seconds

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

OK

Returns Folder of type(s) application/json

This response body class contains all of the following: BaseEntity , InlineFolder1

{
    "entity_id": "1000:104:12213212",
    "name": "My Name",
    "entity_type": "VirtualMachine",
    "vendor_id": "string",
    "vcenter_manager": {
        "entity_id": "string",
        "entity_type": "VirtualMachine",
        "entity_name": "string"
    }
}

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure

On This Page

Request

Path Parameters

Query Parameters

200 Response Body

Errors

Entities Operations

Bulk Fetch Problem Events

Bulk Fetch Vendor Info

Get details Of entities

Get AWS Account Manager

Get Azure Subscription

Get Direct Connect Interface

Get Direct Connect Interfaces

Get Distributed Virtual Portgroup

Get Distributed Virtual Switch

Get Firewall Manager

Get Firewall Rule

Get HCX Appliance

Get HCX Appliances

Get HCX Compute Profile

Get HCX Compute Profiles

Get HCXL2 Extension

Get HCXL2 Extensions

Get HCX Manager

Get HCX Managers

Get HCX Network Profile

Get HCX Network Profiles

Get HCX Service

Get HCX Service Mesh

Get HCX Service Meshes

Get HCX Services

Get HCX Tunnels

Get IP Sec VPN Session

Get IP Sec VPN Sessions

Get Kubernetes Cluster Entities

Get Kubernetes Cluster Entity

Get Kubernetes Namespace

Get Kubernetes Node

Get Kubernetes Pod

Get Kubernetes Service

Get Layer2 Network

Get Logical Router

Get Logical Routers

Get NSX Manager

Get NSXT Controller

Get NSXT Edge Cluster

Get NSXT Edge Node CPU Core By Id

Get NSXT Edge Node CPU Cores

Get NSXT Management Node

Get NSXT Transport Node

Get Problem Event

Get Router Interface

Get Sddc Groups

Get Security Group

Get Security Tag

Get Service Group

Get Switch Port

Get Vcenter Manager

Get Virtual Disk

Get Virtual Disks

Get Vmc AWS Dx Connection

Get Vmc AWS Dx Connections

Get VM Ware Transit Gateway

Get VM Ware Transit Gateways

List AWS Account Managers

List Azure Subscription

List Datacenters

List Datastores

List Distributed Virtual Portgroups

List Distributed Virtual Switches

List Firewall Managers

List Firewall Rules

List Kubernetes Namespaces

List Kubernetes Nodes

List Kubernetes Pods

List Kubernetes Services

List Layer2 Networks

List NSX Managers

List NSXT Controllers

List NSXT Edge Clusters

List NSXT Management Nodes

List NSXT Transport Nodes

List Problem Events

List Routerinterfaces

List Security Groups

List Security Tags

List Service Groups

List Switchports

List Vcenter Managers