platform context API TAP 2016 APR 1

Overview

Api endpoints for providing basic information about platform instance

Contact information

License information

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

URI scheme

Host: platform-context.domain BasePath: /

Tags

• platform-context-controller: Platform Context Controller

Paths

Exposing information about external tools installed in platform

GET /rest/external_tools

Description

Privilege level: Consumer of this endpoint must be a member of specified space.

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	org	org	true	string

Responses

HTTP Code	Description	Schema
200	OK	ExternalTool array

Consumes

• application/json

Produces

• application/json

Tags

• platform-context-controller

Exposing platform specific information

GET /rest/platform_context

Description

Privilege level: Valid OAuth2 token

Responses

HTTP Code	Description	Schema
200	OK	PlatformContext

Consumes

• application/json

Produces

• application/json

Tags

• platform-context-controller

Definitions

ExternalTool

Name	Description	Required	Schema	Default
available		false	boolean
name		false	string
url		false	string

ExternalTools

Name	Description	Required	Schema	Default
visualizations		false	ExternalTool array

PlatformContext

Name	Description	Required	Schema	Default
api_endpoint		false	string
cli_url		false	string
cli_version		false	string
external_tools		false	ExternalTools