platform snapshot API 0.7

Overview

Api endpoints for discovering artifact version from whole platform

Contact information

License information

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

URI scheme

Host: platform-snapshot.branch-v07-nokrb.gotapaas.eu BasePath: /

Tags

• platform-snapshot-controller: Platform Snapshot Controller

Paths

Get platform snapshot configuration

GET /rest/v1/configuration

Description

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

Responses

HTTP Code	Description	Schema
200	OK	PlatformSnapshotConfiguration

Consumes

• application/json

Produces

• application/json

Tags

• platform-snapshot-controller

Get platform snapshots

GET /rest/v1/snapshots

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
QueryParameter	from	from	false	ref
QueryParameter	to	to	false	ref
QueryParameter	scope	scope	false	ref

Responses

HTTP Code	Description	Schema
200	OK	Collection«PlatformSnapshot»

Consumes

• application/json

Produces

• application/json

Tags

• platform-snapshot-controller

Trigger platform snapshot generation

GET /rest/v1/snapshots/trigger

Description

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

Responses

HTTP Code	Description	Schema
200	OK	No Content

Consumes

• application/json

Produces

• application/json

Tags

• platform-snapshot-controller

Get platform snapshot by id

GET /rest/v1/snapshots/{id}

Description

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

Parameters

Type	Name	Description	Required	Schema	Default
PathParameter	id	id	true	integer (int64)

Responses

HTTP Code	Description	Schema
200	OK	PlatformSnapshot

Consumes

• application/json

Produces

• application/json

Tags

• platform-snapshot-controller

Get platform components versions

GET /rest/v1/versions

Description

Privilege level: Consumer of this endpoint must be a user.

Responses

HTTP Code	Description	Schema
200	OK	PlatformSnapshot

Consumes

• application/json

Produces

• application/json

Tags

• platform-snapshot-controller

Definitions

CdhServiceArtifact

Name	Description	Required	Schema	Default
entityStatus		false	string
healthSummary		false	string
name		false	string
serviceState		false	string
type		false	string

CfApplicationArtifact

Name	Description	Required	Schema	Default
buildpack		false	string
command		false	string
createdAt		false	string (date-time)
detectedBuildpack		false	string
detectedStartCommand		false	string
diskQuota		false	integer (int64)
guid		false	string
healthCheckTimeout		false	integer (int64)
healthCheckType		false	string
instances		false	integer (int64)
memory		false	integer (int64)
name		false	string
organization		false	string
scope		false	enum (CORE, DEMO, OTHER, ALL)
space		false	string
state		false	string
updatedAt		false	string (date-time)
version		false	string

CfServiceArtifact

Name	Description	Required	Schema	Default
createdAt		false	string (date-time)
description		false	string
guid		false	string
label		false	string
updatedAt		false	string (date-time)

Collection«CdhServiceArtifact»

Name	Description	Required	Schema	Default
empty		false	boolean

Collection«CfApplicationArtifact»

Name	Description	Required	Schema	Default
empty		false	boolean

Collection«CfServiceArtifact»

Name	Description	Required	Schema	Default
empty		false	boolean

Collection«PlatformSnapshot»

Name	Description	Required	Schema	Default
empty		false	boolean

Collection«string»

Name	Description	Required	Schema	Default
empty		false	boolean

PlatformSnapshot

Name	Description	Required	Schema	Default
applications		false	Collection«CfApplicationArtifact»
cdhServices		false	Collection«CdhServiceArtifact»
cdhVersion		false	string
cfServices		false	Collection«CfServiceArtifact»
cfVersion		false	string
createdAt		false	string (date-time)
id		false	integer (int64)
platformVersion		false	string

PlatformSnapshotConfiguration

Name	Description	Required	Schema	Default
scopes		false	Collection«string»