Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 4.78 KB

InfrastructureApi.md

File metadata and controls

130 lines (82 loc) · 4.78 KB
Raw

{{classname}}

All URIs are relative to **

Method HTTP request Description
InventoryControllerDeployInfrastructure Post /api/v2/infrastructures/{infrastructureId}/actions/deploy Deploys the specified infrastructure
InventoryControllerGetInfrastructure Get /api/v2/infrastructures/{infrastructureId} Retrieves the specified infrastructure
InventoryControllerGetInfrastructures Get /api/v2/infrastructures Get all infrastructures
InventoryControllerRevertInfrastructure Post /api/v2/infrastructures/{infrastructureId}/actions/revert Reverts the specified infrastructure

InventoryControllerDeployInfrastructure

interface{} InventoryControllerDeployInfrastructure(ctx, body, infrastructureId) Deploys the specified infrastructure

Deploys the specified infrastructure

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body InfrastructureDeployOptions The infrastructure deploy options
infrastructureId float64

Return type

interface{}

Authorization

JWT, apiKey

HTTP request headers

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

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

InventoryControllerGetInfrastructure

InventoryControllerGetInfrastructure(ctx, infrastructureId) Retrieves the specified infrastructure

Retrieves the specified infrastructure

Required Parameters

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

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

InventoryControllerGetInfrastructures

[]InfrastructureDto InventoryControllerGetInfrastructures(ctx, optional) Get all infrastructures

Returns list of all infrastructures

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a InfrastructureApiInventoryControllerGetInfrastructuresOpts struct

Name Type Description Notes
accountId optional.Float64 The account ID to filter user infrastructures by

Return type

[]InfrastructureDto

Authorization

JWT, apiKey

HTTP request headers

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

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

InventoryControllerRevertInfrastructure

InventoryControllerRevertInfrastructure(ctx, infrastructureId) Reverts the specified infrastructure

Reverts the specified infrastructure

Required Parameters

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

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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