service catalog API TAP 2016 APR 1

Overview

Api endpoints for managing services and applications in TAP

Contact information

License information

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

URI scheme

Host: service-catalog.domain BasePath: /

Tags

atk-controller: Atk Controller
applications-controller: Applications Controller
service-instances-controller: Service Instances Controller
services-controller: Services Controller
service-bindings-controller: Service Bindings Controller
service-keys-controller: Service Keys Controller
summary-controller: Summary Controller

Paths

Get applications from given space

GET /rest/apps

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	space	space	false	string
QueryParameter	service_label	service_label	false	ref

Responses

HTTP Code	Description	Schema
200	OK	Collection??CcApp??

Consumes

application/json

Produces

application/json

Tags

applications-controller

Removes application, cascade option allows removing bounded service instances for given application

DELETE /rest/apps/{app}

Description

Privilege level: Consumer of this endpoint must have access to space within application is running. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	app	app	true	string
QueryParameter	cascade	cascade	false	ref

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

application/json

Produces

/

Tags

applications-controller

Get application details

GET /rest/apps/{app}

Description

Privilege level: Consumer of this endpoint must have access to space within application is running. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	app	app	true	string

Responses

HTTP Code	Description	Schema
200	OK	CcAppSummary

Consumes

application/json

Produces

application/json

Tags

applications-controller

Get service instances bounded only to given application

GET /rest/apps/{app}/orphan_services

Description

Privilege level: Consumer of this endpoint must have access to space within application is running. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	app	app	true	string

Responses

HTTP Code	Description	Schema
200	OK	Collection??CcServiceInstance??

Consumes

application/json

Produces

application/json

Tags

applications-controller

Get service bindings for the application

GET /rest/apps/{app}/service_bindings

Description

Privilege level: Consumer of this endpoint must have access to space within application is running. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	app	app	true	string

Responses

HTTP Code	Description	Schema
200	OK	CcServiceBindingList

Consumes

application/json

Produces

application/json

Tags

service-bindings-controller

Creates service binding for the application

POST /rest/apps/{app}/service_bindings

Description

Privilege level: Consumer of this endpoint must have access to space that service belongs to. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	app	app	true	string
BodyParameter	service	service	true	CcNewServiceBinding

Responses

HTTP Code	Description	Schema
200	OK	CcServiceBinding

Consumes

application/json

Produces

application/json

Tags

service-bindings-controller

Restages application

POST /rest/apps/{app}/status

Description

Privilege level: Consumer of this endpoint must have access to space within application is running. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	app	app	true	string
BodyParameter	status	status	true	CcAppStatus

Responses

HTTP Code	Description	Schema
200	OK	No Content
400	Request was malformed when application status is null	No Content

Consumes

application/json

Produces

/

Tags

applications-controller

createScoringEngine

POST /rest/atk/scoring-engine

Parameters

Type	Name	Description	Required	Schema	Default
BodyParameter	request	request	true	ScoringEngineRequest

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

application/json

Produces

application/json

Tags

atk-controller

Register application in catalog

POST /rest/marketplace/application

Description

Privilege level: Consumer of this endpoint must be a member of organization

Parameters

Type	Name	Description	Required	Schema	Default
BodyParameter	data	data	true	ServiceRegistrationRequest

Responses

HTTP Code	Description	Schema
200	OK	CcPlanVisibility array
403	Request was malformed while registering without organization access	No Content

Consumes

application/json

Produces

application/json

Tags

services-controller

Removes service binding for the application

DELETE /rest/service_bindings/{binding}

Description

Privilege level: Consumer of this endpoint must have access to space within binding is registered. Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	binding	binding	true	string

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

application/json

Produces

/

Tags

service-bindings-controller

Get services instances filtering by broker in space

GET /rest/service_instances

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	space	space	false	string
QueryParameter	broker	broker	false	string

Responses

HTTP Code	Description	Schema
200	OK	Collection??ServiceInstance??

Consumes

application/json

Produces

application/json

Tags

service-instances-controller

Creates service instance

POST /rest/service_instances

Description

Privilege level: Consumer of this endpoint must be a member of space to create service instance

Parameters

Type	Name	Description	Required	Schema	Default
BodyParameter	serviceInstance	serviceInstance	true	CcNewServiceInstance

Responses

HTTP Code	Description	Schema
200	OK	CcExtendedServiceInstance
409	Request was malformed when service name is already in use	No Content

Consumes

application/json

Produces

application/json

Tags

service-instances-controller

Get space summary with instance metadata injected

GET /rest/service_instances/extended_summary

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	space	space	true	string

Responses

HTTP Code	Description	Schema
200	OK	Summary

Consumes

application/json

Produces

application/json

Tags

service-instances-controller

Get services instances summary

GET /rest/service_instances/summary

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	space	space	true	string
QueryParameter	service_keys	service_keys	false	boolean

Responses

HTTP Code	Description	Schema
200	OK	Collection??Service??

Consumes

application/json

Produces

application/json

Tags

service-instances-controller

Removes service instance

DELETE /rest/service_instances/{instance}

Description

Privilege level: Consumer of this endpoint must have access to space that service instance belongs to Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	instance	instance	true	string

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

application/json

Produces

/

Tags

service-instances-controller

Get all service keys

GET /rest/service_keys

Description

Privilege level: Consumer of this endpoint must be user authenticated in Cloud Foundry

Responses

HTTP Code	Description	Schema
200	OK	Collection??ServiceKey??

Consumes

application/json

Produces

application/json

Tags

service-keys-controller

Adds new service key

POST /rest/service_keys

Description

Privilege level: Consumer of this endpoint must be user authenticated in Cloud Foundry

Parameters

Type	Name	Description	Required	Schema	Default
BodyParameter	serviceKey	serviceKey	true	CcNewServiceKey

Responses

HTTP Code	Description	Schema
200	OK	ServiceKey

Consumes

application/json

Produces

application/json

Tags

service-keys-controller

Removes service key

DELETE /rest/service_keys/{guid}

Description

Privilege level: Consumer of this endpoint must be user authenticated in Cloud Foundry

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	guid	guid	true	string

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

application/json

Produces

application/json

Tags

service-keys-controller

Get plan guid for service using label

GET /rest/service_plan

Description

Privilege level: Consumer of this endpoint must have access to space that service belongs to Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	label	label	true	string
QueryParameter	plan	plan	true	string

Responses

HTTP Code	Description	Schema
200	OK	ServicePlanResponse

Consumes

application/json

Produces

application/json

Tags

services-controller

Get summary for services in space

GET /rest/services

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	space	space	false	string

Responses

HTTP Code	Description	Schema
200	OK	Collection??CcExtendedService??

Consumes

application/json

Produces

application/json

Tags

services-controller

Get available plans for service using label

GET /rest/services/{label}/service_plans

Description

Privilege level: Consumer of this endpoint must have access to space that service belongs to Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	label	label	true	string

Responses

HTTP Code	Description	Schema
200	OK	Collection??CcExtendedServicePlan??

Consumes

application/json

Produces

application/json

Tags

services-controller

Get service summary

GET /rest/services/{service}

Description

Privilege level: Consumer of this endpoint must have access to space that service belongs to Verification is performed by Cloud Controller using user token

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	service	service	true	string

Responses

HTTP Code	Description	Schema
200	OK	CcExtendedService

Consumes

application/json

Produces

application/json

Tags

services-controller

Get summary for apps and service deployed in space

GET /rest/summaries

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	space	space	false	string

Responses

HTTP Code	Description	Schema
200	OK	CcSummary

Consumes

application/json

Produces

application/json

Tags

summary-controller

Definitions

App

Name	Description	Required	Schema	Default
guid		false	string
name		false	string

CcApp

Name	Required	Schema
guid	false	string
name	false	string
running_instances	false	integer (int32)
service_names	false	string array
state	false	enum (STARTED, STOPPED, RESTAGING, RESTARTING)
urls	false	string array

CcAppStatus

Name	Description	Required	Schema	Default
state		false	enum (STARTED, STOPPED, RESTAGING, RESTARTING)

CcAppSummary

Name	Required	Schema
available_domain	false	string
buildpack	false	string
command	false	string
detected_buildpack	false	string
detected_buildpack_guid	false	string
disk_quota	false	integer (int64)
environment_json	false	object
guid	false	string
health_check_timeout	false	string
instances	false	integer (int64)
memory	false	integer (int64)
name	false	string
package_state	false	string
package_updated_at	false	string
routes	false	object
running_instances	false	integer (int64)
services	false	Collection??CcServiceInstance??
space_guid	false	string
stack_guid	false	string
staging_task_id	false	string
state	false	string
system_env_json	false	object
version	false	string

CcExtendedService

Name	Description	Required	Schema	Default
entity		false	CcExtendedServiceEntity
metadata		false	CcMetadata

CcExtendedServiceEntity

Name	Required	Schema
active	false	boolean
bindable	false	boolean
description	false	string
documentation_url	false	string
extra	false	string
info_url	false	string
label	false	string
long_Description	false	string
plan_updateable	false	boolean
provider	false	string
requires	false	object
service_broker_guid	false	string
service_plans	false	Collection??CcExtendedServicePlan??
service_plans_url	false	string
tags	false	object
unique_id	false	string
url	false	string
version	false	string

CcExtendedServiceInstance

Name	Description	Required	Schema	Default
entity		false	CcExtendedServiceInstanceEntity
metadata		false	CcMetadata

CcExtendedServiceInstanceEntity

Name	Required	Schema
credentials	false	object
dashboard_url	false	string
gateway_data	false	string
last_operation	false	object
name	false	string
service_bindings_url	false	string
service_keys	false	Collection??CcServiceKey??
service_keys_url	false	string
service_plan	false	CcExtendedServicePlan
service_plan_guid	false	string
service_plan_url	false	string
space_guid	false	string
space_url	false	string
tags	false	object
type	false	string

CcExtendedServicePlan

Name	Description	Required	Schema	Default
entity		false	CcExtendedServicePlanEntity
metadata		false	CcMetadata

CcExtendedServicePlanEntity

Name	Required	Schema
active	false	boolean
description	false	string
extra	false	string
free	false	boolean
metadata	false	CcMetadata
name	false	string
public	false	boolean
service	false	CcExtendedService
service_guid	false	string
service_instances_url	false	string
service_url	false	string
unique_id	false	string

CcLastOperation

Name	Required	Schema
description	false	string
state	false	enum (in progress, succeeded, failed)
type	false	enum (create, update, delete)

CcMetadata

Name	Description	Required	Schema	Default
guid		false	string

CcNewServiceBinding

Name	Description	Required	Schema	Default
app_guid		false	string
service_instance_guid		false	string

CcNewServiceInstance

Name	Required	Schema
name	false	string
organization_guid	false	string
parameters	false	object
service_plan_guid	false	string
space_guid	false	string

CcNewServiceKey

Name	Description	Required	Schema	Default
name		false	string
service_instance_guid		false	string

CcPlanVisibility

Name	Description	Required	Schema	Default
entity		false	CcPlanVisibilityEntity
metadata		false	CcMetadata

CcPlanVisibilityEntity

Name	Description	Required	Schema	Default
organization_guid		false	string
service_plan_guid		false	string

CcService

Name	Description	Required	Schema	Default
guid		false	string
label		false	string

CcServiceBinding

Name	Description	Required	Schema	Default
entity		false	CcServiceBindingEntity
metadata		false	CcMetadata

CcServiceBindingEntity

Name	Description	Required	Schema	Default
app_guid		false	string
service_instance_guid		false	string

CcServiceBindingList

Name	Description	Required	Schema	Default
next_url		false	string
resources		false	Collection??CcServiceBinding??

CcServiceInstance

Name	Required	Schema
bound_app_count	false	integer (int32)
dashboard_url	false	string
guid	false	string
last_operation	false	CcLastOperation
name	false	string
service_plan	false	CcServicePlan

CcServiceKey

Name	Description	Required	Schema	Default
entity		false	CcServiceKeyEntity
metadata		false	CcMetadata

CcServiceKeyEntity

Name	Required	Schema
credentials	false	object
name	false	string
service_instance_guid	false	string

CcServicePlan

Name	Description	Required	Schema	Default
name		false	string
service		false	CcService

CcSummary

Name	Description	Required	Schema	Default
apps		false	Collection??CcApp??
services		false	Collection??CcServiceInstance??

Collection??App??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??CcApp??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??CcExtendedServicePlan??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??CcExtendedService??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??CcServiceBinding??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??CcServiceInstance??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??CcServiceKey??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??ServiceInstance??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??ServiceKey??

Name	Description	Required	Schema	Default
empty		false	boolean

Collection??Service??

Name	Description	Required	Schema	Default
empty		false	boolean

ScoringEngineRequest

Name	Required	Schema
atk_name	false	string
instance_name	false	string
organization_guid	false	string
service_plan_guid	false	string
space_guid	false	string

Service

Name	Required	Schema
extra	false	string
guid	false	string
instances	false	Collection??ServiceInstance??
label	false	string
tags	false	object

ServiceInstance

Name	Required	Schema
bound_apps	false	Collection??App??
dashboard_url	false	string
guid	false	string
last_operation	false	CcLastOperation
metadata	false	ServiceInstanceMetadata
name	false	string
service	false	string
service_keys	false	Collection??ServiceKey??
service_plan	false	CcServicePlan

ServiceInstanceMetadata

Name	Description	Required	Schema	Default
creator_guid		false	string
creator_name		false	string

ServiceKey

Name	Required	Schema
credentials	false	object
guid	false	string
name	false	string
service_instance_guid	false	string

ServicePlanResponse

Name	Description	Required	Schema	Default
guid		false	string

ServiceRegistrationApp

Name	Description	Required	Schema	Default
metadata		false	CcMetadata

ServiceRegistrationMetadata

Name	Description	Required	Schema	Default
displayName		false	string
imageUrl		false	string

ServiceRegistrationRequest

Name	Required	Schema
app	false	ServiceRegistrationApp
description	false	string
metadata	false	ServiceRegistrationMetadata
name	false	string
org_guid	false	string
tags	false	string array

Summary

Name	Description	Required	Schema	Default
apps		false	Collection??CcApp??
services		false	Collection??ServiceInstance??

Home | FAQs

[Overview of Trusted Analytics Platform](Overview of Trusted Analytics Platform)
[Getting Started Guide](Getting Started Guide)
Space Shuttle Demo Application
Trusted Analytics JIRA Project
[Building TAP from sources] (Building-TAP-from-sources)
PaaS Architecture
Use-cases
- [High Level Use Case](High Level Use Case)
- [Model Development for Data Scientists](Model Development for Data Scientists)
Platform Tips and Tricks
Platform Security Features
- Managing User Accounts in Kerberos
Platform Configurations
Release Notes
- 2015 09 Release Notes
- 2016 01 Release Notes
Additional Deployment Information