platform operations API TAP 2016 APR 1

Overview

Api endpoints for gathering platform statistics

Contact information

License information

License: Apache License Version 2.0 License URL: http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host: platform-operations.domain BasePath: /

Tags

• platform-controller: Platform Controller

Paths

Get Platform statistics

GET /rest/platform/summary

Description

Privilege level: Consumer of this endpoint must be an admin.

Responses

HTTP Code	Description	Schema
200	OK	PlatformSummary

Consumes

• application/json

Produces

• application/json

Tags

• platform-controller

Trigger refresh of Platform statistics

POST /rest/platform/summary/refresh_cache

Description

Privilege level: Consumer of this endpoint must be an admin.

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

• application/json

Produces

• /

Tags

• platform-controller

Definitions

CcBuildpack

Name	Description	Required	Schema	Default
entity		false	CcBuildpackEntity
metadata		false	CcMetadata

CcBuildpackEntity

Name	Description	Required	Schema	Default
enabled		false	boolean
filename		false	string
locked		false	boolean
name		false	string
position		false	integer (int32)

CcMetadata

Name	Description	Required	Schema	Default
guid		false	string

CcOrgSummary

Name	Description	Required	Schema	Default
guid		false	string
name		false	string
spaces		false	Collection??CcOrgSummarySpace??
status		false	string

CcOrgSummarySpace

Name	Description	Required	Schema	Default
appCount		false	integer (int32)
guid		false	string
memDevTotal		false	integer (int32)
memProdTotal		false	integer (int32)
name		false	string
serviceCount		false	integer (int32)

Collection??CcOrgSummarySpace??

Name	Description	Required	Schema	Default
empty		false	boolean

ComponentMetrics

Name	Description	Required	Schema	Default
availableDiskRatio		false	number (double)
availableMemoryRatio		false	number (double)
canStage		false	integer (int64)
cpu		false	number (double)
cpuLoadAvg		false	number (double)
host		false	string
memBytes		false	integer (int64)
memFreeBytes		false	integer (int64)
memUsedBytes		false	integer (int64)
numCores		false	integer (int64)
reservableStagers		false	integer (int64)
start		false	string
totalWardenResponseTimeInMs		false	integer (int64)
uptime		false	string
uuid		false	string
wardenRequestCount		false	integer (int64)

ComponentSummary

Name	Description	Required	Schema	Default
componentMetrics		false	ComponentMetrics array
memFreeInMb		false	integer (int64)
memUsedInMb		false	integer (int64)
reservableStagers		false	integer (int64)

ControllerSummary

Name	Description	Required	Schema	Default
appCount		false	integer (int64)
buildpackCount		false	integer (int64)
buildpacks		false	CcBuildpack array
memUsedInMb		false	integer (int64)
orgCount		false	integer (int64)
orgs		false	CcOrgSummary array
serviceCount		false	integer (int64)
serviceInstancesCount		false	integer (int64)
spaceCount		false	integer (int64)
userCount		false	integer (int64)

PlatformSummary

Name	Description	Required	Schema	Default
componentSummary		false	ComponentSummary
controllerSummary		false	ControllerSummary
id		false	string
timestamp		false	string (date-time)