semaphore_client

Semaphore API provides endpoints for managing and interacting with the Semaphore UI. This documentation outlines the available operations and data models.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2.16.14
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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 semaphore_client

Setuptools

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 semaphore_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import semaphore_client
from semaphore_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = semaphore_client.Configuration(
    host = "/api"
)



# Enter a context with an instance of the API client
with semaphore_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = semaphore_client.AuthenticationApi(api_client)

    try:
        # Fetches login metadata
        api_response = api_instance.auth_login_get()
        print("The response of AuthenticationApi->auth_login_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->auth_login_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api

Documentation For Models

• APIToken
• AcceptInviteRequest
• AccessKey
• AccessKeyRequest
• AccessKeyRequestLoginPassword
• AccessKeyRequestSsh
• AnsibleTaskParams
• Environment
• EnvironmentRequest
• EnvironmentSecret
• EnvironmentSecretRequest
• Event
• InfoType
• Integration
• IntegrationAlias
• IntegrationExtractValue
• IntegrationExtractValueRequest
• IntegrationMatcher
• IntegrationMatcherRequest
• IntegrationRequest
• Inventory
• InventoryRequest
• Login
• LoginMetadata
• LoginMetadataOidcProvidersInner
• Project
• ProjectBackup
• ProjectBackupEnvironmentsInner
• ProjectBackupInventoriesInner
• ProjectBackupKeysInner
• ProjectBackupMeta
• ProjectBackupRepositoriesInner
• ProjectBackupTemplatesInner
• ProjectBackupViewsInner
• ProjectInvite
• ProjectInviteRequest
• ProjectProjectIdPutRequest
• ProjectProjectIdRoleGet200Response
• ProjectProjectIdTasksPostRequest
• ProjectProjectIdTasksTaskIdStopPostRequest
• ProjectProjectIdTemplatesTemplateIdStopAllTasksPostRequest
• ProjectProjectIdUsersPostRequest
• ProjectProjectIdUsersUserIdPutRequest
• ProjectRequest
• ProjectUser
• Repository
• RepositoryRequest
• Runner
• Schedule
• ScheduleRequest
• Task
• TaskOutput
• TaskParams
• TaskPrams
• Template
• TemplateRequest
• TemplateSurveyVar
• TemplateSurveyVarValue
• TemplateVault
• TerraformTaskParams
• User
• UserPutRequest
• UserRequest
• UserTokensPostRequest
• UsersUserIdPasswordPostRequest
• View
• ViewRequest

Documentation For Authorization

Authentication schemes defined for the API:

cookie

• Type: API key
• API key parameter name: Cookie
• Location: HTTP header

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author