Skip to content

Latest commit

 

History

History
181 lines (106 loc) · 4.87 KB

PlatformApi.md

File metadata and controls

181 lines (106 loc) · 4.87 KB
Raw

\PlatformApi

All URIs are relative to http://localhost

Method HTTP request Description
PlatformAdd Post /1.0/platforms
PlatformDelete Delete /1.0/platforms/{platform}
PlatformInfo Get /1.6/platforms/{platform}
PlatformList Get /1.0/platforms
PlatformRollback Post /1.6/platforms/{platform}/rollback
PlatformUpdate Put /1.0/platforms/{platform}

PlatformAdd

PlatformAdd(ctx, name, dockerfileContent)

Add new platform.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string
dockerfileContent os.Fileos.File

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/x-json-stream

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

PlatformDelete

PlatformDelete(ctx, platform)

Delete platform.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
platform string Platform 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]

PlatformInfo

PlatformInfo PlatformInfo(ctx, platform)

Platform info.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
platform string Platform info.

Return type

PlatformInfo

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]

PlatformList

[]Platform PlatformList(ctx, )

List platforms.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Platform

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]

PlatformRollback

PlatformRollback(ctx, platform, image)

Platform rollback.

Required Parameters

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

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]

PlatformUpdate

PlatformUpdate(ctx, platform, dockerfileContent)

Update platform.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
platform string Platform name.
dockerfileContent os.Fileos.File

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/x-json-stream

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