Skip to content

Latest commit

 

History

History
893 lines (543 loc) · 26.9 KB

ServiceApi.md

File metadata and controls

893 lines (543 loc) · 26.9 KB
Raw

\ServiceApi

All URIs are relative to http://localhost

Method HTTP request Description
InstanceCreate Post /1.0/services/{service}/instances
InstanceDelete Delete /1.0/services/{service}/instances/{instance}
InstanceGet Get /1.0/services/{service}/instances/{instance}
InstanceUpdate Put /1.0/services/{service}/instances/{instance}
InstancesList Get /1.0/services/instances
JobServiceInstanceBind Put /1.13/services/{service}/instances/{instance}/jobs/{job}
JobServiceInstanceUnbind Delete /1.13/services/{service}/instances/{instance}/jobs/{job}
ServiceAddDoc Put /1.0/services/{name}/doc
ServiceBrokerCreate Post /1.7/brokers
ServiceBrokerDelete Delete /1.7/brokers/{name}
ServiceBrokerList Get /1.7/brokers
ServiceBrokerUpdate Put /1.7/brokers/{name}
ServiceCreate Post /1.0/services
ServiceDelete Delete /1.0/services/{name}
ServiceDoc Get /1.0/services/{name}/doc
ServiceGrantTeam Put /1.0/services/{service}/team/{team}
ServiceInfo Get /1.0/services/{name}
ServiceInstanceBind Put /1.13/services/{service}/instances/{instance}/apps/{app}
ServiceInstanceBind10 Put /1.0/services/{service}/instances/{instance}/{app}
ServiceInstanceGrant Put /1.0/services/{service}/instances/permission/{instance}/{team}
ServiceInstanceRevoke Delete /1.0/services/{service}/instances/permission/{instance}/{team}
ServiceInstanceStatus Get /1.0/services/{service}/instances/{instance}/status
ServiceInstanceUnbind Delete /1.13/services/{service}/instances/{instance}/apps/{app}
ServiceInstanceUnbind10 Delete /1.0/services/{service}/instances/{instance}/{app}
ServicePlans Get /1.0/services/{name}/plans
ServiceRevokeTeam Delete /1.0/services/{service}/team/{team}
ServiceUpdate Put /1.0/services/{name}
ServicesList Get /1.0/services

InstanceCreate

InstanceCreate(ctx, service, serviceInstance)

Create a service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
serviceInstance ServiceInstance

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InstanceDelete

InstanceDelete(ctx, service, instance, unbindall)

Remove service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
unbindall bool Remove current binds to this instance

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InstanceGet

ServiceInstanceInfo InstanceGet(ctx, service, instance)

Get service instance information

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.

Return type

ServiceInstanceInfo

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InstanceUpdate

InstanceUpdate(ctx, service, instance, serviceInstanceUpdateData)

Update a service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
serviceInstanceUpdateData ServiceInstanceUpdateData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InstancesList

[]ServiceList InstancesList(ctx, optional)

List service instances

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *InstancesListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a InstancesListOpts struct

Name Type Description Notes
app optional.String Filter instances by app name

Return type

[]ServiceList

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobServiceInstanceBind

JobServiceInstanceBind(ctx, service, instance, job, jobServiceInstanceBind)

Bind the service instance to job

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
job string Job name.
jobServiceInstanceBind JobServiceInstanceBind

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobServiceInstanceUnbind

JobServiceInstanceUnbind(ctx, service, instance, job, jobServiceInstanceUnbind)

Unbind the service instance from job

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
job string Job name.
jobServiceInstanceUnbind JobServiceInstanceUnbind

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceAddDoc

ServiceAddDoc(ctx, name, optional)

Documentation on a service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service name.
optional *ServiceAddDocOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServiceAddDocOpts struct

Name Type Description Notes

doc | optional.String| |

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceBrokerCreate

ServiceBrokerCreate(ctx, serviceBroker)

Create service broker

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceBroker ServiceBroker

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceBrokerDelete

ServiceBrokerDelete(ctx, name)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service Broker name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceBrokerList

ServiceBrokerList ServiceBrokerList(ctx, )

List service brokers

Required Parameters

This endpoint does not need any parameter.

Return type

ServiceBrokerList

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceBrokerUpdate

ServiceBrokerUpdate(ctx, name, serviceBroker)

Update service broker

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service Broker name.
serviceBroker ServiceBroker

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceCreate

ServiceCreate(ctx, optional)

Creates a new service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ServiceCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServiceCreateOpts struct

Name Type Description Notes
id optional.String
username optional.String
password optional.String
endpoint optional.String
multiCluster optional.String
team optional.String

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceDelete

ServiceDelete(ctx, name)

Delete a service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceDoc

ServiceDoc(ctx, name)

Documentation on a service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceGrantTeam

ServiceGrantTeam(ctx, service, team)

Grant access to team for the service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
team string Team name

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInfo

[]ServiceInfo ServiceInfo(ctx, name)

Information on a service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service name.

Return type

[]ServiceInfo

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceBind

ServiceInstanceBind(ctx, service, instance, app, serviceInstanceBind)

Bind the service instance to app

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
app string App name.
serviceInstanceBind ServiceInstanceBind

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceBind10

ServiceInstanceBind10(ctx, service, instance, app, serviceInstanceBind)

Bind the service instance to app

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
app string App name.
serviceInstanceBind ServiceInstanceBind

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceGrant

ServiceInstanceGrant(ctx, service, instance, team)

Grant access to team for this service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
team string Team name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceRevoke

ServiceInstanceRevoke(ctx, service, instance, team)

Revoke access to team for this service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
team string Team name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceStatus

ServiceInstanceStatus(ctx, service, instance)

Status for service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceUnbind

ServiceInstanceUnbind(ctx, service, instance, app, serviceInstanceUnbind)

Unbind the service instance from app

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
app string App name.
serviceInstanceUnbind ServiceInstanceUnbind

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceInstanceUnbind10

ServiceInstanceUnbind10(ctx, service, instance, app, serviceInstanceUnbind)

Unbind the service instance from app

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
instance string Instance name.
app string App name.
serviceInstanceUnbind ServiceInstanceUnbind

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/x-json-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServicePlans

[]ServicePlan ServicePlans(ctx, name, optional)

Plans for a service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service name.
optional *ServicePlansOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServicePlansOpts struct

Name Type Description Notes

pool | optional.String| |

Return type

[]ServicePlan

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceRevokeTeam

ServiceRevokeTeam(ctx, service, team)

Revoke access to team for the service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
service string Service name.
team string Team name

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServiceUpdate

ServiceUpdate(ctx, name, optional)

Updates a service

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Service name.
optional *ServiceUpdateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServiceUpdateOpts struct

Name Type Description Notes

id | optional.String| | username | optional.String| | password | optional.String| | endpoint | optional.String| | multiCluster | optional.String| | team | optional.String| |

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ServicesList

[]ServiceList ServicesList(ctx, )

List services

Required Parameters

This endpoint does not need any parameter.

Return type

[]ServiceList

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]