UnmarshalAuthConfigOAuth unmarshals polymorphic AuthConfigOAuth.

UnmarshalAuthConfigOAuthSlice unmarshals polymorphic slices of AuthConfigOAuth.

UnmarshalCloudProviderConfiguration unmarshals polymorphic CloudProviderConfiguration.

UnmarshalCloudProviderConfigurationSlice unmarshals polymorphic slices of CloudProviderConfiguration.

UnmarshalExternalBackendConfiguration unmarshals polymorphic ExternalBackendConfiguration.

UnmarshalExternalBackendConfigurationSlice unmarshals polymorphic slices of ExternalBackendConfiguration.

CheckReportStatusError captures enum value "Error".

CheckReportStatusSuccess captures enum value "Success".

CheckReportStatusUnknown captures enum value "Unknown".

CloudCostManagementAccountParentStatusError captures enum value "error".

CloudCostManagementAccountParentStatusIdle captures enum value "idle".

CloudCostManagementAccountParentStatusImport captures enum value "import".

CloudCostManagementAccountPhaseBlue captures enum value "blue".

CloudCostManagementAccountPhaseGreen captures enum value "green".

CloudCostManagementAccountStatusError captures enum value "error".

CloudCostManagementAccountStatusIdle captures enum value "idle".

CloudCostManagementAccountStatusImport captures enum value "import".

CloudProviderCanonicalAlibaba captures enum value "alibaba".

CloudProviderCanonicalAws captures enum value "aws".

CloudProviderCanonicalAzurerm captures enum value "azurerm".

CloudProviderCanonicalFlexibleengine captures enum value "flexibleengine".

CloudProviderCanonicalGoogle captures enum value "google".

CloudProviderCanonicalKubernetes captures enum value "kubernetes".

CloudProviderCanonicalOpenstack captures enum value "openstack".

CloudProviderCanonicalOracle captures enum value "oracle".

CloudProviderCanonicalOvh captures enum value "ovh".

CloudProviderCanonicalScaleway captures enum value "scaleway".

CloudProviderCanonicalVmware captures enum value "vmware".

CloudProviderCanonicalVsphere captures enum value "vsphere".

CredentialRawEnvironmentChina captures enum value "china".

CredentialRawEnvironmentGerman captures enum value "german".

CredentialRawEnvironmentPublic captures enum value "public".

CredentialRawEnvironmentUsgovernment captures enum value "usgovernment".

CredentialSimpleTypeAws captures enum value "aws".

CredentialSimpleTypeAzure captures enum value "azure".

CredentialSimpleTypeAzureStorage captures enum value "azure_storage".

CredentialSimpleTypeBasicAuth captures enum value "basic_auth".

CredentialSimpleTypeCustom captures enum value "custom".

CredentialSimpleTypeElasticsearch captures enum value "elasticsearch".

CredentialSimpleTypeGcp captures enum value "gcp".

CredentialSimpleTypeSSH captures enum value "ssh".

CredentialSimpleTypeSwift captures enum value "swift".

CredentialSimpleTypeVmware captures enum value "vmware".

CredentialTypeAws captures enum value "aws".

CredentialTypeAzure captures enum value "azure".

CredentialTypeAzureStorage captures enum value "azure_storage".

CredentialTypeBasicAuth captures enum value "basic_auth".

CredentialTypeCustom captures enum value "custom".

CredentialTypeElasticsearch captures enum value "elasticsearch".

CredentialTypeGcp captures enum value "gcp".

CredentialTypeSSH captures enum value "ssh".

CredentialTypeSwift captures enum value "swift".

CredentialTypeVmware captures enum value "vmware".

EventSeverityCrit captures enum value "crit".

EventSeverityErr captures enum value "err".

EventSeverityInfo captures enum value "info".

EventSeverityWarn captures enum value "warn".

EventTypeAWS captures enum value "AWS".

EventTypeCustom captures enum value "Custom".

EventTypeCycloid captures enum value "Cycloid".

EventTypeMonitoring captures enum value "Monitoring".

FormEntityTypeArray captures enum value "array".

FormEntityTypeBoolean captures enum value "boolean".

FormEntityTypeFloat captures enum value "float".

FormEntityTypeInteger captures enum value "integer".

FormEntityTypeMap captures enum value "map".

FormEntityTypeString captures enum value "string".

FormEntityWidgetAutoComplete captures enum value "auto_complete".

FormEntityWidgetCyBranch captures enum value "cy_branch".

FormEntityWidgetCyCred captures enum value "cy_cred".

FormEntityWidgetCyCrs captures enum value "cy_crs".

FormEntityWidgetCyInventoryResource captures enum value "cy_inventory_resource".

FormEntityWidgetCyScs captures enum value "cy_scs".

FormEntityWidgetDropdown captures enum value "dropdown".

FormEntityWidgetHidden captures enum value "hidden".

FormEntityWidgetNumber captures enum value "number".

FormEntityWidgetRadios captures enum value "radios".

FormEntityWidgetSimpleText captures enum value "simple_text".

FormEntityWidgetSliderList captures enum value "slider_list".

FormEntityWidgetSliderRange captures enum value "slider_range".

FormEntityWidgetSwitch captures enum value "switch".

FormEntityWidgetTextArea captures enum value "text_area".

GeneralStatusStatusError captures enum value "Error".

GeneralStatusStatusSuccess captures enum value "Success".

GeneralStatusStatusUnknown captures enum value "Unknown".

InfraImportStatusFailed captures enum value "failed".

InfraImportStatusImporting captures enum value "importing".

InfraImportStatusSucceeded captures enum value "succeeded".

InfraPolicySeverityAdvisory captures enum value "advisory".

InfraPolicySeverityCritical captures enum value "critical".

InfraPolicySeverityWarning captures enum value "warning".

KPITypeBuildAvgTime captures enum value "build_avg_time".

KPITypeBuildFrequency captures enum value "build_frequency".

KPITypeBuildHistory captures enum value "build_history".

KPITypeCodeCoverage captures enum value "code_coverage".

KPITypeTimeToRelease captures enum value "time_to_release".

KPIWidgetBars captures enum value "bars".

KPIWidgetDoughnut captures enum value "doughnut".

KPIWidgetHistory captures enum value "history".

KPIWidgetLine captures enum value "line".

KPIWidgetPie captures enum value "pie".

KPIWidgetStackbars captures enum value "stackbars".

KPIWidgetSummary captures enum value "summary".

MemberOrgInvitationStateAccepted captures enum value "accepted".

MemberOrgInvitationStateDeclined captures enum value "declined".

MemberOrgInvitationStatePending captures enum value "pending".

MemberOrgLocaleEn captures enum value "en".

MemberOrgLocaleEs captures enum value "es".

MemberOrgLocaleFr captures enum value "fr".

NewAWSMarketplaceUserAccountLocaleEn captures enum value "en".

NewAWSMarketplaceUserAccountLocaleEs captures enum value "es".

NewAWSMarketplaceUserAccountLocaleFr captures enum value "fr".

NewCredentialTypeAws captures enum value "aws".

NewCredentialTypeAzure captures enum value "azure".

NewCredentialTypeAzureStorage captures enum value "azure_storage".

NewCredentialTypeBasicAuth captures enum value "basic_auth".

NewCredentialTypeCustom captures enum value "custom".

NewCredentialTypeElasticsearch captures enum value "elasticsearch".

NewCredentialTypeGcp captures enum value "gcp".

NewCredentialTypeSSH captures enum value "ssh".

NewCredentialTypeSwift captures enum value "swift".

NewCredentialTypeVmware captures enum value "vmware".

NewEventSeverityCrit captures enum value "crit".

NewEventSeverityErr captures enum value "err".

NewEventSeverityInfo captures enum value "info".

NewEventSeverityWarn captures enum value "warn".

NewEventTypeAWS captures enum value "AWS".

NewEventTypeCustom captures enum value "Custom".

NewEventTypeCycloid captures enum value "Cycloid".

NewEventTypeMonitoring captures enum value "Monitoring".

NewExternalBackendPurposeCostExplorer captures enum value "cost_explorer".

NewExternalBackendPurposeEvents captures enum value "events".

NewExternalBackendPurposeLogs captures enum value "logs".

NewExternalBackendPurposeRemoteTfstate captures enum value "remote_tfstate".

NewInfraPolicySeverityAdvisory captures enum value "advisory".

NewInfraPolicySeverityCritical captures enum value "critical".

NewInfraPolicySeverityWarning captures enum value "warning".

NewKPITypeBuildAvgTime captures enum value "build_avg_time".

NewKPITypeBuildFrequency captures enum value "build_frequency".

NewKPITypeBuildHistory captures enum value "build_history".

NewKPITypeCodeCoverage captures enum value "code_coverage".

NewKPITypeTimeToRelease captures enum value "time_to_release".

NewKPIWidgetBars captures enum value "bars".

NewKPIWidgetDoughnut captures enum value "doughnut".

NewKPIWidgetHistory captures enum value "history".

NewKPIWidgetLine captures enum value "line".

NewKPIWidgetPie captures enum value "pie".

NewKPIWidgetStackbars captures enum value "stackbars".

NewKPIWidgetSummary captures enum value "summary".

NewOAuthUserLocaleEn captures enum value "en".

NewOAuthUserLocaleEs captures enum value "es".

NewOAuthUserLocaleFr captures enum value "fr".

NewRuleEffectAllow captures enum value "allow".

NewUserAccountLocaleEn captures enum value "en".

NewUserAccountLocaleEs captures enum value "es".

NewUserAccountLocaleFr captures enum value "fr".

PipelineDiffStatusAdded captures enum value "added".

PipelineDiffStatusChanged captures enum value "changed".

PipelineDiffStatusRemoved captures enum value "removed".

PipelineStatusSyncedErrored captures enum value "errored".

PipelineStatusSyncedOutOfSync captures enum value "out_of_sync".

PipelineStatusSyncedSynced captures enum value "synced".

PipelineStatusSyncedUnknown captures enum value "unknown".

ProjectImportStatusFailed captures enum value "failed".

ProjectImportStatusImporting captures enum value "importing".

ProjectImportStatusSucceeded captures enum value "succeeded".

ProjectSimpleImportStatusFailed captures enum value "failed".

ProjectSimpleImportStatusImporting captures enum value "importing".

ProjectSimpleImportStatusSucceeded captures enum value "succeeded".

RuleEffectAllow captures enum value "allow".

ServiceCatalogImportStatusFailed captures enum value "failed".

ServiceCatalogImportStatusImporting captures enum value "importing".

ServiceCatalogImportStatusSucceeded captures enum value "succeeded".

UpdateCredentialTypeAws captures enum value "aws".

UpdateCredentialTypeAzure captures enum value "azure".

UpdateCredentialTypeAzureStorage captures enum value "azure_storage".

UpdateCredentialTypeBasicAuth captures enum value "basic_auth".

UpdateCredentialTypeCustom captures enum value "custom".

UpdateCredentialTypeElasticsearch captures enum value "elasticsearch".

UpdateCredentialTypeGcp captures enum value "gcp".

UpdateCredentialTypeSSH captures enum value "ssh".

UpdateCredentialTypeVmware captures enum value "vmware".

UpdateExternalBackendPurposeCostExplorer captures enum value "cost_explorer".

UpdateExternalBackendPurposeEvents captures enum value "events".

UpdateExternalBackendPurposeLogs captures enum value "logs".

UpdateExternalBackendPurposeRemoteTfstate captures enum value "remote_tfstate".

UpdateInfraPolicySeverityAdvisory captures enum value "advisory".

UpdateInfraPolicySeverityCritical captures enum value "critical".

UpdateInfraPolicySeverityWarning captures enum value "warning".

UpdateProjectCloudProviderAws captures enum value "aws".

UpdateProjectCloudProviderAzurerm captures enum value "azurerm".

UpdateProjectCloudProviderFlexibleengine captures enum value "flexibleengine".

UpdateProjectCloudProviderGoogle captures enum value "google".

UpdateProjectCloudProviderOpenstack captures enum value "openstack".

UpdateUserAccountLocaleEn captures enum value "en".

UpdateUserAccountLocaleEs captures enum value "es".

UpdateUserAccountLocaleFr captures enum value "fr".

UserAccountLocaleEn captures enum value "en".

UserAccountLocaleEs captures enum value "es".

UserAccountLocaleFr captures enum value "fr".

APIKey API key The entity which represents the information of an API key.

AppConfig AppConfig Global app configuration that includes all the settings and capabilities of the Cycloid instance.

Appearance Appearance # An Appearance holds the values of the branding configuration, which are rendered across an organization swagger:model Appearance.

AppearanceColor appearance color swagger:model AppearanceColor.

AppVersion AppVersion swagger:model AppVersion.

AuthConfig AuthConfig swagger:model AuthConfig.

AuthConfigLocalAuth AppConfigLocalAuth swagger:model AuthConfigLocalAuth.

AuthConfigSAML AppConfigSAML swagger:model AuthConfigSAML.

AWSCloudWatchLogs Representation of AWS cloud watch logs for external backend.

AWSInfrastructureResourcesAggregation AWS Infrastructure Resources Aggregation MinProperties: 1 MaxProperties: 12 swagger:model AWSInfrastructureResourcesAggregation.

AWSRemoteTFState Deprecated.

AWSStorage Representation of AWS storage for external backend.

AzureADAuthConfig AppConfigAzureADOAuth # AzureAD OAuth configuration swagger:model AzureADAuthConfig.

AzureCostExport Representation of AzureCostExport external backend.

AzureRemoteTFState Deprecated.

AzureStorage Representation of azure remote tf state for external backend.

Build Build The information relative to a build.

BuildInputsOutputs BuildInputsOutputs Represent the resources input/output related to a build swagger:model BuildInputsOutputs.

BuildSummary BuildSummary The information relative to a build summary.

CanDoInput CanDoInput The input of the 'can_do' endpoint swagger:model CanDoInput.

CanDoOutput CanDoOutput The output of the 'can_do' endpoint swagger:model CanDoOutput.

CheckReport CheckReport swagger:model CheckReport.

ClearTaskCache ClearTaskCache The entity which represents number of cache cleared for a task.

CloudCostManagementAccount CloudCostManagementAccount # Object containing Cloud Cost Management account parameters swagger:model CloudCostManagementAccount.

CloudCostManagementAccountParent CloudCostManagementAccountParent Object containing Cloud Cost Management parent account parameters.

CloudCostManagementBucket CloudCostManagementBucket A sum of the cost generated in a period aggregated by one or more terms, for example if we aggregate costs by project here we have all the cost generated by a specific project in the period of time defined by the filters of the histogram.

CloudCostManagementDashboard CloudCostManagementDashboard The dashboard of the Cloud Cost Management, it contains - a histogram of the cost in the period aggregated by provider and by time granularity - a histogram of the cost aggregated by the top projects and providers and filtered by the top projects - a list of resources and relative cost for each top projects - a map containing properties that can be specified filtering the returned results, with a set of valid values for each.

CloudCostManagementFilterValues CloudCostManagementFilterValues A collection of the values for which the cost can be filtered, i.e.

CloudCostManagementHistogram CloudCostManagementHistogram The histogram of the costs for a period composed of buckets that aggregate the costs.

CloudCostManagementLinkedAccount CloudCostManagementLinkedAccount An account that is linked to a Cloud Cost Management account in the cloud provider.

CloudCostManagementProjectProviderResources CloudCostManagementProjectProviderResources # Trend for a project swagger:model CloudCostManagementProjectProviderResources.

CloudCostManagementProjectResources CloudCostManagementProjectResources The new resources and associated cost for a project in a period of time.

CloudCostManagementProjectsDashboard CloudCostManagementProjectsDashboard The projects dashboard of the Cloud Cost Management, it contains - a histogram of the cost aggregated by date and project - a histogram of cost aggregated by projects and providers swagger:model CloudCostManagementProjectsDashboard.

CloudCostManagementProviderDetails CloudCostManagementProviderDetails # Description of the costs of a specific provider swagger:model CloudCostManagementProviderDetails.

CloudCostManagementProviders CloudCostManagementProviders # Date histogram of the cost of all the providers swagger:model CloudCostManagementProviders.

CloudCostManagementTagMapping CloudCostManagementTagMapping Object containing Cloud Cost Management tag mapping.

CloudProvider Cloud Provider CloudProvider represents a cloud provider.

CloudProviderAWSConfiguration Representation of AWS configuration swagger:model CloudProviderAWSConfiguration.

CloudProviderAzureConfiguration Representation of Azure configuration swagger:model CloudProviderAzureConfiguration.

CloudProviderGCPConfiguration Representation of Google configuration swagger:model CloudProviderGCPConfiguration.

CloudProviderVMWareVSphereConfiguration Representation of VMware vSphere configuration swagger:model CloudProviderVMWareVSphereConfiguration.

ConfigFile SC config file # This object contains SC config file name and its content swagger:model ConfigFile.

ConfigRepository ConfigRepository swagger:model ConfigRepository.

CostEstimationComponent CostEstimationComponent Cost component of a cloud resource estimate.

CostEstimationComponentState CostEstimationComponentState Either a Prior or Planned cost component state.

CostEstimationResourceEstimate CostEstimationResourceEstimate Estimate for a single cloud resource.

CostEstimationResult CostEstimationResult The result of cost estimation.

CostGroup CostGroup This object contains the items described in https://docs.aws.amazon.com/sdk-for-go/api/service/costexplorer/#Group The groups hold the information about the price per key(s) for each iteration over the time range requested.

CostGroupDefinitions CostGroupDefinitions This object contains the items describe in https://docs.aws.amazon.com/sdk-for-go/api/service/costexplorer/#GroupDefinition It also grouping the costs based on different elements: az, services, tags, etc swagger:model CostGroupDefinitions.

CostResultByTime CostResultByTime This object contains the items described in https://docs.aws.amazon.com/sdk-for-go/api/service/costexplorer/#ResultByTime It is basically containing information about the cost per group(s) and per granularity (daily/monthly) over the period of time selected.

CostTimePeriod CostTimePeriod This object contains the items described in https://docs.aws.amazon.com/sdk-for-go/api/service/costexplorer/#DateInterval It defines the beginning and the end of the time frame for which, the API should gather costs.

Country Country # Single country Representation swagger:model Country.

Credential Credential # Represents the Credential swagger:model Credential.

CredentialInUse Credential in use InUse represents the resources that are using provided credential.

CredentialRaw Credential Raw # All the possible fields inside it swagger:model CredentialRaw.

CredentialSimple Credential Simple # Represents the Credential without the raw and owner swagger:model CredentialSimple.

ElasticsearchLogs Representation of Elasticsearch logs for external backend.

ElasticsearchLogsSourcesAnon elasticsearch logs sources anon swagger:model ElasticsearchLogsSourcesAnon.

ElasticsearchLogsSourcesAnonMapping Object with the mapping to know which attributes are the ones we have to map to the ones we want swagger:model ElasticsearchLogsSourcesAnonMapping.

EnsurePlan EnsurePlan The plan to ensure to be run.

Environment Environment # Represent an environment with may be related to a Project and Pipeline swagger:model Environment.

ErrorDetailsItem Error details item Represents an item of the list of details of an error.

ErrorPayload Error Payload The payload used by the server to response to the client with an Error, those errors could be any of the ones listed [here](https://github.com/cycloidio/youdeploy-http-api/blob/develop/errors/code.go#L10), only the CODE of the error is the one that is guaranteed to not change between the same major version, the MESSAGE could change.

Event An event A event which has registered an activity in the Cycloid platform.

ExternalBackend External backend An external backend contains the configuration needed in order to be plugged into the Cycloid system.

FormEntity Forms file's Entity # This describes all the attributes possible to configure a form's variable swagger:model FormEntity.

FormGroup Forms File Group swagger:model FormGroup.

FormInput Forms input The variables set within a form with the corresponding environment canonical and use case swagger:model FormInput.

FormInputs Forms inputs The array of variables set by the user via the forms with the associated environment canonical and use case upon project creation.

FormSection Forms File Section swagger:model FormSection.

FormsFileV2 Forms File V2 swagger:model FormsFileV2.

FormsValidation Forms validation # Validates a given Form's file swagger:model FormsValidation.

FormsValidationResult FormsValidationResult # The result of the validation, if errors is empty means that is correct swagger:model FormsValidationResult.

FormsValuesRef Forms values ref # It has the information to get the values of an entity of the Form swagger:model FormsValuesRef.

FormUseCase Forms File Use case swagger:model FormUseCase.

GCPCostStorage Representation of BigQuery external backend.

GCPRemoteTFState Deprecated.

GCPStorage Representation of GCP remote tf state for external backend.

GeneralStatus GeneralStatus swagger:model GeneralStatus.

GetPlan GetPlan The plan to get before running another one.

GitHubOAuthConfig AppConfigGitHubOAuth GitHub OAuth configuration.

GitLabHTTPStorage Representation of GitLab HTTP storage for external backend.

GoogleOAuthConfig AppConfigGoogleOAuth # Google OAuth configuration swagger:model GoogleOAuthConfig.

GroupConfig GroupConfig # The entity which represents pipeline group config swagger:model GroupConfig.

HTTPStorage Representation of HTTP storage for external backend.

InfraImport Infra Import The entity which represents the information of for the import of a new Stack or Project.

InfraImportPreset InfraImportPreset Infra Import's pre-configured group with Resources commonly used together in a specific context.

InfraImportResource Infra Import Resource The representation of the Infra Import's Resource of a Cloud Provider.

InfraImportResourceBody Provider Resources body # Entry that represents all the data needed for fetching resource swagger:model InfraImportResourceBody.

InfraImportResourcesBody Provider's Resources body # Entry that represents all the data needed for fetching resources swagger:model InfraImportResourcesBody.

InfraPoliciesValidationResult Infra policies validation results.

InfraPoliciesValidationResultItem InfraPoliciesValidationResultItem represents a checked rule with a failed result generated from the validation process.

InfraPolicy InfraPolicy The policy to control operations across infrastructure.

Infrastructure Infrastructure # Holds all the Infrastructure of the project in an environment swagger:model Infrastructure.

InfrastructureGraph InfrastructureGraph # Holds all the Infrastructure of the project in an environment in Graph format swagger:model InfrastructureGraph.

InfrastructureGraphEdge Infrastructure # Holds the information of an Edge of the Graph swagger:model InfrastructureGraphEdge.

InfrastructureGraphNode Infrastructure # Holds the information of a Node of the Graph swagger:model InfrastructureGraphNode.

InfrastructureResourcesAggregationItem Infrastructure Resource Aggregation Item Contains aggregated data of a single type of an infrastructure resource.

InUseConfigRepository InUseConfigRepository # Represents a Config repository that's using credential swagger:model InUseConfigRepository.

InUseEnvironment InUseEnvironment # Represents an environment that's using credential swagger:model InUseEnvironment.

InUseExternalBackend InUseExternalBackend # Represents a external backend that's using credential swagger:model InUseExternalBackend.

InUseProject InUseProject # Represents a project that's using credential swagger:model InUseProject.

InUseServiceCatalogSource InUseServiceCatalogSource # Represents a Service catalog source that's using credential swagger:model InUseServiceCatalogSource.

InventoryResource Inventory Resource # The Resource of the Inventory representing an element of your infrastructure swagger:model InventoryResource.

InventoryResourceLabel Inventory Resource Label # Aggregated information of resources having a label swagger:model InventoryResourceLabel.

Job Job The entity which represents a job output in the application.

JobInput JobInput The entity which represents a job input in the application.

JobOutput JobOutput The entity which represents a job output in the application.

KPI KPI # A KPI swagger:model KPI.

Licence Licence # Object containing licence parameters swagger:model Licence.

LogSource A log source The data associated to a log's source.

LogSourceEntry Log entry A log's entry which pertains to a specific log's source.

MemberAssignation Member assignation Member is a user who is associated to an entity of the system.

MemberOrg Member of an organization Member is a user who is associated to an organization.

MemberTeam Member of a team Member is a user who is associated to a team.

MetadataField MetadataField # Represent the metadata of a build input swagger:model MetadataField.

NewAPIKey Create API key The entity which represents the information of a new API key.

NewAppearance Appearance # An Appearance holds the values of the branding configuration, which are rendered across an organization swagger:model NewAppearance.

NewAppearanceColor new appearance color swagger:model NewAppearanceColor.

NewAWSMarketplaceUserAccount Sign up from AWS Marketplace Create a new AWS Marketplace user account.

NewCloudCostManagementAccount Create CloudCostManagementAccount Create a new Cloud Cost Management account to connect CP.

NewCloudCostManagementAccountChild Create CloudCostManagementAccountChild Create a new Cloud Cost Management Child account.

NewConfigRepository NewConfigRepository swagger:model NewConfigRepository.

NewCredential Credential # Represents the Credential swagger:model NewCredential.

NewEnvironment NewEnvironment # Represent an entity necessary for environment creation swagger:model NewEnvironment.

NewEvent A new event A new event to register in the Cycloid platform.

NewExternalBackend New External backend An external backend contains the configuration needed in order to be plugged into the Cycloid system.

NewInfraImport New Infra Import # Entry that represents all the data needed to import a stack swagger:model NewInfraImport.

NewInfraImportExternalBackend New External backend An external backend contains the configuration needed in order to be plugged into the Cycloid system.

NewInfraImportProject Create Project for the Infra Import The entity which represents the information of a new project.

NewInfraPolicy Create InfraPolicy Create a new policy to control operations across infrastructure.

NewInventoryResource New Inventory Resource # The Resource of the Inventory representing an element of your infrastructure swagger:model NewInventoryResource.

NewKPI New KPI # A KPI's configuration that needs to be saved swagger:model NewKPI.

NewLicence Licence # Object containing licence parameters swagger:model NewLicence.

NewMemberInvitation Invite user Send an invitation to a user to something.

NewOAuthUser User's OAuth information # The User OAuth information swagger:model NewOAuthUser.

NewOrganization Create Organization The entity which represents a new organization to create in the application.

NewPipeline Create Pipeline The entity which represents a new pipeline to create in the application.

NewProject Create Project The entity which represents the information of a new project.

NewQuota New Quota # The Quota defines the basic needs to create a quota swagger:model NewQuota.

NewResourcePool New Resource Pool The Resource Pool defines the basic needs to create/update a resource pool swagger:model NewResourcePool.

NewRole New role access control New role represents the authorization level that a user has access to.

NewRule NewRule NewRule represents an existing or new permission or constraint to access to an entity of the system.

NewServiceCatalog Service Catalog # Represents the Service Catalog item swagger:model NewServiceCatalog.

NewServiceCatalogFromTemplate Service Catalog # Represents the Service Catalog item swagger:model NewServiceCatalogFromTemplate.

NewServiceCatalogSource NewServiceCatalogSource swagger:model NewServiceCatalogSource.

NewSubscription New Subscription # It reflects the creation of a Subscription swagger:model NewSubscription.

NewTeam Create Team The entity which represents the information of a new team.

NewTeamMemberAssignation Assign user # Member is a user assigned to a Team swagger:model NewTeamMemberAssignation.

NewUserAccount Sign up Create a new user account.

OnFailurePlan OnFailurePlan The plan definition when the action has failed.

OnSuccessPlan OnSuccessPlan The plan definition when the action has been successful.

Organization Organization The entity which holds all the direct information attached to an organization.

PageConcourse PageConcourse swagger:model PageConcourse.

Pagination Pagination swagger:model Pagination.

PaginationAWS AWS Pagination swagger:model PaginationAWS.

PaginationConcourse PaginationConcourse swagger:model PaginationConcourse.

PendingMemberInvitation PendingMemberInvitation # Contains the email used for the member invitation swagger:model PendingMemberInvitation.

PinComment PinComment # Represents a pin comment of a resource swagger:model PinComment.

Pipeline Pipeline The entity which represents a pipeline in the application.

PipelineDiff PipelineDiff Represents a diff element of a PipelineDiffs.

PipelineDiffRecord PipelineDiffRecord # Represents a diff record of a pipeline diff swagger:model PipelineDiffRecord.

PipelineDiffs PipelineDiffs # Represents the diffs between two pipelines swagger:model PipelineDiffs.

PipelineStatus PipelineStatus Pipeline status returned upon pipelines comparison between the one locally stored in the database and its counter part on git.

PipelineVariables Pipeline variables The entity which contains pipeline's variables.

Plan Plan The plan is what represent a concourse build.

PlanConfig PlanConfig The plan configuration when creating new build.

Policy Policy Policy represents a permission or constraint to access to an entity of the system.

Preparation Preparation swagger:model Preparation.

Project Project The entity which represents the information of a project.

ProjectEnvironmentConfig Project Environment Config Representation of project's environment configuration done via the forms.

ProjectEnvironmentConsumption ProjectEnvironmentConsumption # The Consumption of a Project in an Environment swagger:model ProjectEnvironmentConsumption.

ProjectSimple ProjectSimple The entity which represents minimal information of a project.

PublicBuildInput PublicBuildInput # Represent the information of a build input swagger:model PublicBuildInput.

PublicBuildOutput PublicBuildOutput # Represents the information of a build output swagger:model PublicBuildOutput.

PublicPlan PublicPlan The public plan returned requesting a build plan.

PutPlan PutPlan The put plan following a plan.

Quota Quota # A Quota holds the information of the restrictions applied to a Team having as source a Resource Pool swagger:model Quota.

Resource Resource The entity which represents a resource in the application.

ResourcePool Resource Pool A Resource Pool holds the information of all the Resources that have the same label.

ResourceVersion ResourceVersion # Represent the outputs of a job swagger:model ResourceVersion.

Role Role access control Role represents the authorization level that an user has to access to a specific entity of the system.

Rule Rule # Rules define the specific access to the platform swagger:model Rule.

SCConfig SC Config # This entity is being used for automatic creation of SC config swagger:model SCConfig.

SCConfigPathConfig Path Configuration # Represents a Configuration which holds Path and Content swagger:model SCConfigPathConfig.

SCConfigPathDestConfig Path and Destination Configuration # Represents a Configuration which holds Path, Destination and Content swagger:model SCConfigPathDestConfig.

SCConfigPipelineConfig Pipeline Configuration # Represents the Service Catalog Configuration for a Pipeline of a given Use Case swagger:model SCConfigPipelineConfig.

SCConfigUseCaseConfig Use Case Configuration # Represents the Service Catalog Configuration for a given Use Case swagger:model SCConfigUseCaseConfig.

ServiceCatalog Service Catalog # Represents the Service Catalog item swagger:model ServiceCatalog.

ServiceCatalogChanges ServiceCatalogChanges Represents list of service catalogs changes during the refresh of a service catalog source.

ServiceCatalogDependenciesValidationResult ServiceCatalogValidationResult The result of the Service Catalog dependencies validation.

ServiceCatalogDependency ServiceCatalogDependency # Service Catalog Dependency identifies ServiceCatalog being dependency of other swagger:model ServiceCatalogDependency.

ServiceCatalogSource ServiceCatalogSource swagger:model ServiceCatalogSource.

ServiceCatalogTechnology ServiceCatalogTechnology # ServiceCatalogTechnology is a Technology of the Service Catalog swagger:model ServiceCatalogTechnology.

SimpleTeam SimpleTeam The entity which represents the information of a team a bit simplified.

State State # The State of an Inventory of the Project's environment swagger:model State.

StateLock State Lock # The Lock management of a State in the Inventory of the Project's environment swagger:model StateLock.

StateResource State Resource # The Resource of a State in the Inventory of the Project's environment swagger:model StateResource.

StateResourceInstances State Resource Instances # The Instances inside Resources of a State in the Inventory of the Project's environment swagger:model StateResourceInstances.

Subscription Subscription It reflects the relation between an Organization and a Plan which could be the Free Trial or others, for more info check https://www.cycloid.io/pricing swagger:model Subscription.

SubscriptionPlan SubscriptionPlan # It reflects the Plan used for the subscription swagger:model SubscriptionPlan.

Summary Summary of the organization swagger:model Summary.

SwiftRemoteTFState Deprecated.

SwiftStorage Representation of Swift remote tf state for external backend.

Tag Key and value pair Key and value pair defined with the widely adopted name, tag.

TaskConfig TaskConfig The configuration of a concourse task.

TaskInputConfig TaskInputConfig The configuration of inputs for concourse tasks.

TaskPlan TaskPlan The task plan.

TaskRunConfig TaskRunConfig The configuration of a concourse task-run.

Team Team The entity which represents the information of a team.

TerraformHCLConfig TerraformHCLConfig # The HCL config for Terraform swagger:model TerraformHCLConfig.

TerraformImage TerraformImage # The Image from the TF structure swagger:model TerraformImage.

TerraformJSONConfig TerraformJSONConfig # The JSON config for Terraform swagger:model TerraformJSONConfig.

TerraformPlanInput TerraformPlanInput Input for endpoints that require a Terraform plan.

TerraformProvider Provider # Provider of infrastructure swagger:model TerraformProvider.

TerraformProviderResource Resource # A Resource of a Provider swagger:model TerraformProviderResource.

TerraformProviderResourceAttributes ResourceAttributes # Holds specific logic of some attributes swagger:model TerraformProviderResourceAttributes.

TerraformProviderResourceSimple ResourceSimple # A Resource of a Provider without the config swagger:model TerraformProviderResourceSimple.

TerraformProviderSimple TerraformProviderSimple # Provider of infrastructure without the config swagger:model TerraformProviderSimple.

TerraformValidationResult TerraformValidationResult # The result of the validation, if errors is empty means that is correct swagger:model TerraformValidationResult.

TimeoutPlan EnsurePlan The plan to ensure to be run.

TryPlan EnsurePlan The plan to ensure to be run.

UpdateAPIKey Update API key The entity which represents the information of the API key to be updated.

UpdateCloudCostManagementAccount Update CloudCostManagementAccount Update a Cloud Cost Management account to connect CP.

UpdateCloudCostManagementLinkedAccount Update CloudCostManagementLinkedAccount Attributes of a CCM linked accout that can be updated by a user.

UpdateCloudCostManagementTagMapping Create or Update CloudCostManagementTagMapping # Create or Update a Cloud Cost Management tag mapping for projects and environments swagger:model UpdateCloudCostManagementTagMapping.

UpdateConfigRepository UpdateConfigRepository swagger:model UpdateConfigRepository.

UpdateCredential Credential # Represents the Credential swagger:model UpdateCredential.

UpdateExternalBackend Update External backend An external backend contains the configuration needed in order to be plugged into the Cycloid system.

UpdateInfraPolicy Update InfraPolicy Update a policy to control operations across infrastructure.

UpdateOrganization Update Organization The entity which represents the information of an organization to be updated.

UpdatePipeline Update Pipeline The entity which represents a new pipeline config to update in the application.

UpdateProject Update Project The entity which represents the information of the project to be updated.

UpdateQuota Update Quota # The Quota defines the basic needs to update a create swagger:model UpdateQuota.

UpdateServiceCatalogSource UpdateServiceCatalogSource swagger:model UpdateServiceCatalogSource.

UpdateTeam Update Team The entity which represents the information of the team to be updated.

UpdateUserAccount Update user's account The user's account information of the authenticated user to be updated.

UpdateUserAccountEmail User's email The email address of a user to be updated.

UpdateUserAccountPasswordUpdate The update password requires to confirm the old password.

User Basic info of a user A summary of a user to be used in places where only the basic information are need or are enough.

UserAccount User's account The user's account contains information related with the authenticated user.

UserAccountEmail User's email The email address of a user.

UserEmail User email address # The user's email address swagger:model UserEmail.

UserLogin Log in Validate the user to access to the application.

UserOAuth User's OAuth information The User OAuth information, if it's on the platform it'll return the 'token' to login, if not the 'user' to show to the user swagger:model UserOAuth.

UserPasswordResetReq User password reset request Request to send a token for allowing the user to reset its current password.

UserPasswordResetUpdate User password reset update Reset the current user password to the one provided.

UserSession User's session The JWT which allows the user to access to the application.

VersionConfig VersionConfig The entity which represents a version configuration in the application.

VersionedResourceType VersionedResourceType The versioned resources type.

VMwareVsphere Representation of VMwareVsphere external backend.

Worker Worker The entity which represents a worker in the application.

AuthConfigOAuth AppConfigAuthOAuth swagger:discriminator AuthConfigOAuth type.

AWSInfrastructureResourceBucket AWS Infrastructure S3 bucket Resource This object contains the items described in the S3 bucket data type described in but it also contains its associated tags which are documented in the properties of this object definition.

AWSInfrastructureResourceDBInstance AWS Infrastructure RDS DB instance Resource This object contains the items described in the RDS DB instance data type described in https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBInstance.html but it also contains its associated tags which are documented in the properties of this object definition.

AWSInfrastructureResourceElasticacheCluster AWS Infrastructure Elasticache cluster Resource This object contains the items described in the ElastiCache cluster data type described in https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheCluster.html but it also contains its associated tags which are documented in the properties of this object definition.

AWSInfrastructureResourceImage AWS Infrastructure image Resource This object contains the items described in the image data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Image.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

AWSInfrastructureResourceInstance AWS Infrastructure Instance Resource This object contains the items described in the instance data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

AWSInfrastructureResourceLoadBalancerV1 AWS Infrastructure load balancer (ELB) Resource This object contains the items described in the load balancer (ELB) data type described in https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_LoadBalancerDescription.html but it also contains its associated tags which are documented in the properties of this object definition.

AWSInfrastructureResourceLoadBalancerV2 AWS Infrastructure load balancer (ELB v2 or a.k.a ALB) Resource This object contains the items described in the load balancer (ELB v2 or a.k.a ALB) data type described in https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_LoadBalancer.html but it also contains its associated tags which are documented in the properties of this object definition.

AWSInfrastructureResourceSecurityGroup AWS Infrastructure security group Resource This object contains the items described in the security group data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

AWSInfrastructureResourceSnapshot AWS Infrastructure snapshot Resource This object contains the items described in the snapshot data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Snapshot.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

AWSInfrastructureResourceSubnet AWS Infrastructure subnet Resource This object contains the items described in the subnet data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

AWSInfrastructureResourceVolume AWS Infrastructure volume Resource This object contains the items described in the volume data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Volume.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

AWSInfrastructureResourceVPC AWS Infrastructure VPC Resource This object contains the items described in the VPC data type described in https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Vpc.html Tags property is set, for guaranteeing that the respond will always have the property of the type array, not allowing null in case that the resource doesn't have any, hence an empty array is used in such case.

CloudProviderConfiguration cloud provider configuration swagger:discriminator CloudProviderConfiguration type.

ExternalBackendConfiguration external backend configuration swagger:discriminator ExternalBackendConfiguration engine.

Filters Filters # Filters is the possible values the filters can have on list requests swagger:model Filters.

InfrastructureConfig InfrastructureConfig # Holds all the Infrastructure config of the TFState swagger:model InfrastructureConfig.

TerraformJSONDiagram TerraformDiagram # The JSON Diagram structure swagger:model TerraformJSONDiagram.

UserGuide User guide JSON schema # The user's guide progress JSON schema swagger:model UserGuide.

CIVersion CIVersion # Represent a version of a resource swagger:model CIVersion.

SCConfigFormData Form Data # Represents the Data related to Forms that is stored in a SC Configuration for a given Use Case swagger:model SCConfigFormData.

SCConfigTechConfig Tech Configuration # Represents the Service Catalog Configuration for a Technology of a given Use Case swagger:model SCConfigTechConfig.

ServiceCatalogConfig Service Catalog Configuration # Represents a Service Catalog's Config item swagger:model ServiceCatalogConfig.