Octopus Deploy API client in Python (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This Python package is automatically generated by the Swagger Codegen project:
- API version: 2019.6.7+Branch.tags-2019.6.7.Sha.aa18dc6809953218c66f57eff7d26481d9b23d6a
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Modified APIs and Models to support Variable update, Machine info load and Environment APIs.
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import octopus_deploy_swagger_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import octopus_deploy_swagger_client
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import octopus_deploy_swagger_client
from octopus_deploy_swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: APIKeyHeader
configuration = octopus_deploy_swagger_client.Configuration()
configuration.api_key['X-Octopus-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Octopus-ApiKey'] = 'Bearer'
# Configure API key authorization: APIKeyQuery
configuration = octopus_deploy_swagger_client.Configuration()
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Configure API key authorization: NugetApiKeyHeader
configuration = octopus_deploy_swagger_client.Configuration()
configuration.api_key['X-NuGet-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-NuGet-ApiKey'] = 'Bearer'
# create an instance of the API class
api_instance = octopus_deploy_swagger_client.AccountsApi(octopus_deploy_swagger_client.ApiClient(configuration))
account_resource = octopus_deploy_swagger_client.AccountResource() # AccountResource | The AccountResource resource to create (optional)
try:
# Create a AccountResource
api_response = api_instance.create_response_descriptor_environments_accounts_account_accounts_account_resource(account_resource=account_resource)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->create_response_descriptor_environments_accounts_account_accounts_account_resource: %s\n" % e)
All URIs are relative to https://localhost
- AccountResource
- AccountUsageResource
- ActionTemplateCategoryResource
- ActionTemplateParameterResource
- ActionTemplateResource
- ActionTemplateSearchResource
- ActionTemplateUsageResource
- ActionUpdateRemovedPackageUsage
- ActionUpdateResultResource
- ActivityLogElement
- ActivityLogEntry
- ActivityLogTreeNode
- ApiKeyResource
- ArtifactResource
- AuthenticationProviderElement
- AuthenticationProviderThatSupportsGroups
- AuthenticationResource
- AutoDeployReleaseOverrideResource
- AzureEnvironmentResource
- AzureResourceGroupResource
- AzureStorageAccountResource
- AzureWebSiteResourceAzureWebSitesListAction
- AzureWebSiteSlotResource
- BuiltInFeedStatsResource
- CertificateConfigurationResource
- CertificateResource
- CertificateUsageResource
- ChannelResource
- ChannelVersionRuleResource
- CloudTemplateMetadata
- CommitDetails
- CommunityActionTemplateResource
- ConfigurationSectionMetadata
- Control
- DashboardConfigurationResource
- DashboardEnvironmentResource
- DashboardItemResource
- DashboardProjectGroupResource
- DashboardProjectResource
- DashboardResource
- DashboardTenantResource
- DefectResource
- DeploymentActionPackageResource
- DeploymentActionResource
- DeploymentEnvironmentSettingsMetadata
- DeploymentPreviewResource
- DeploymentProcessResource
- DeploymentPromomotionTenant
- DeploymentPromotionTarget
- DeploymentResource
- DeploymentStepResource
- DeploymentTargetResource
- DeploymentTemplateResource
- DeploymentTemplateStep
- DisplayInfo
- DocumentTypeDocument
- EndpointResource
- EnvironmentResource
- EventAgentResource
- EventCategoryResource
- EventGroupResource
- EventNotificationSubscription
- EventNotificationSubscriptionFilter
- EventReference
- EventResource
- ExtensionSettingsValues
- ExtensionsInfoResource
- FeaturesConfigurationResource
- FeedResource
- Form
- FormElement
- IdentityClaimResource
- IdentityResource
- InlineResponse200
- InterruptionResource
- InvitationResource
- Library
- LibraryVariableSetProjectUsage
- LibraryVariableSetReleaseUsageEntry
- LibraryVariableSetResource
- LibraryVariableSetUsageEntry
- LibraryVariableSetUsageResource
- LicenseLimitStatusResource
- LicenseMessageResource
- LicenseResource
- LicenseStatusResource
- LifecycleProgressionResource
- LifecycleResource
- ListApiMetadata
- LoginInitiatedResource
- MachineCleanupPolicy
- MachineConnectionStatus
- MachineConnectivityPolicy
- MachineDeploymentPreview
- MachineHealthCheckPolicy
- MachinePolicyResource
- MachineResource
- MachineScriptPolicy
- MachineUpdatePolicy
- MaintenanceConfigurationResource
- Metadata
- MigrationImportResource
- MigrationPartialExportResource
- MultiTenancyStatusResource
- NamedReferenceItem
- NumericReportData
- NumericReportSeries
- OctopusPackageMetadataMappedResource
- OctopusServerNodeDetailsResource
- OctopusServerNodeResource
- OnboardingResource
- OnboardingTaskResource
- OptionsMetadata
- PackageBuildMetadata
- PackageDescriptionResource
- PackageFromBuiltInFeedResource
- PackageNote
- PackageNoteListResource
- PackageNotesResult
- PackageReference
- PackageResource
- PackageSignatureResource
- PackageVersionResource
- PerformanceConfigurationResource
- PermissionDescription
- PhaseDeploymentResource
- PhaseProgressionResource
- PhaseResource
- ProgressionResource
- Project
- ProjectConnectivityPolicy
- ProjectGroupResource
- ProjectResource
- ProjectSettingsMetadata
- ProjectTriggerResource
- ProjectVariableSetUsage
- ProjectedTeamReferenceDataItem
- PropertyApplicability
- PropertyMetadata
- PropertyValueResource
- ProxyResource
- ReferenceDataItem
- ReleaseChanges
- ReleaseCreationStrategyResource
- ReleasePackageMetadataResource
- ReleaseProgressionResource
- ReleaseResource
- ReleaseTemplatePackage
- ReleaseTemplateResource
- ReleaseUsage
- ReleaseUsageEntry
- ReportDeploymentCountOverTimeResource
- ResourceCollectionAccountResource
- ResourceCollectionActionTemplateResource
- ResourceCollectionApiKeyResource
- ResourceCollectionArtifactResource
- ResourceCollectionCertificateConfigurationResource
- ResourceCollectionCertificateResource
- ResourceCollectionChannelResource
- ResourceCollectionCommunityActionTemplateResource
- ResourceCollectionConfigurationSectionMetadata
- ResourceCollectionDefectResource
- ResourceCollectionDeploymentProcessResource
- ResourceCollectionDeploymentResource
- ResourceCollectionDeploymentTargetResource
- ResourceCollectionEnvironmentResource
- ResourceCollectionFeedResource
- ResourceCollectionInterruptionResource
- ResourceCollectionLibraryVariableSetResource
- ResourceCollectionLifecycleResource
- ResourceCollectionMachinePolicyResource
- ResourceCollectionOctopusServerNodeResource
- ResourceCollectionPackageDescriptionResource
- ResourceCollectionPackageResource
- ResourceCollectionPackageVersionResource
- ResourceCollectionProjectGroupResource
- ResourceCollectionProjectResource
- ResourceCollectionProjectTriggerResource
- ResourceCollectionProxyResource
- ResourceCollectionReleaseResource
- ResourceCollectionScopedUserRoleResource
- ResourceCollectionSpaceResource
- ResourceCollectionSubscriptionResource
- ResourceCollectionTagSetResource
- ResourceCollectionTaskResource
- ResourceCollectionTeamResource
- ResourceCollectionTenantResource
- ResourceCollectionUserResource
- ResourceCollectionUserRoleResource
- ResourceCollectionWorkerPoolResource
- ResourceCollectionWorkerResource
- RetentionPeriod
- RootResource
- ScheduledTaskDetailsResource
- ScheduledTaskStatusResource
- SchedulerStatusResource
- ScopedUserRoleResource
- SelectedPackage
- SensitiveValue
- ServerConfigurationResource
- ServerConfigurationSettingsResource
- ServerConfigurationValueResource
- ServerStatusHealthResource
- ServerTimezoneResource
- SmtpIsConfiguredResource
- SpaceResource
- SpaceRootResource
- StepUsage
- StepUsageEntry
- SubscriptionResource
- TagResource
- TagSetResource
- TargetUsageEntry
- TaskDetailsResource
- TaskProgress
- TaskResource
- TaskTypeResource
- TeamNameResource
- TeamResource
- TenantResource
- TenantVariableResource
- TriggerActionResource
- TriggerFilterResource
- TypeMetadata
- UserAuthenticationResource
- UserPermissionRestriction
- UserPermissionSetResource
- UserPermissionSetResourceSpacePermissions
- UserResource
- UserRoleResource
- VariablePromptOptions
- VariableResource
- VariableResourceScope
- VariableScopeValues
- VariableSetResource
- VariablesScopedToEnvironmentResponse
- VersioningStrategyResource
- WorkItemLink
- WorkerPoolResource
- WorkerResource
- X509Certificate
- Type: API key
- API key parameter name: X-Octopus-ApiKey
- Location: HTTP header
- Type: API key
- API key parameter name: ApiKey
- Location: URL query string
- Type: API key
- API key parameter name: X-NuGet-ApiKey
- Location: HTTP header