semaphore_api.DefaultApi

All URIs are relative to http://localhost:3000/api

Method	HTTP request	Description
events_get	GET /events	Get Events related to Semaphore and projects you are part of
events_last_get	GET /events/last	Get last 200 Events related to Semaphore and projects you are part of
info_get	GET /info	Fetches information about semaphore
ping_get	GET /ping	PING test
project_project_id_users_user_id_put	PUT /project/{project_id}/users/{user_id}	Update user role
ws_get	GET /ws	Websocket handler

events_get

List[Event] events_get()

Get Events related to Semaphore and projects you are part of

Example

Api Key Authentication (cookie):
Api Key Authentication (bearer):

import semaphore_api
from semaphore_api.models.event import Event
from semaphore_api.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: bearer
configuration.api_key['bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

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

    try:
        # Get Events related to Semaphore and projects you are part of
        api_response = api_instance.events_get()
        print("The response of DefaultApi->events_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->events_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[Event]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	Array of events in chronological order	-

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

events_last_get

List[Event] events_last_get()

Get last 200 Events related to Semaphore and projects you are part of

Example

Api Key Authentication (cookie):
Api Key Authentication (bearer):

import semaphore_api
from semaphore_api.models.event import Event
from semaphore_api.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: bearer
configuration.api_key['bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

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

    try:
        # Get last 200 Events related to Semaphore and projects you are part of
        api_response = api_instance.events_last_get()
        print("The response of DefaultApi->events_last_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->events_last_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[Event]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	Array of events in chronological order	-

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

info_get

InfoType info_get()

Fetches information about semaphore

you must be authenticated to use this

Example

Api Key Authentication (cookie):
Api Key Authentication (bearer):

import semaphore_api
from semaphore_api.models.info_type import InfoType
from semaphore_api.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: bearer
configuration.api_key['bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

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

    try:
        # Fetches information about semaphore
        api_response = api_instance.info_get()
        print("The response of DefaultApi->info_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->info_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InfoType

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	ok	-

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

ping_get

str ping_get()

PING test

Example

import semaphore_api
from semaphore_api.rest import ApiException
from pprint import pprint

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


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

    try:
        # PING test
        api_response = api_instance.ping_get()
        print("The response of DefaultApi->ping_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->ping_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

HTTP response details

Status code	Description	Response headers
200	Successful "PONG" reply	* content-type -

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

project_project_id_users_user_id_put

project_project_id_users_user_id_put(project_id, user_id, project_user)

Update user role

Example

Api Key Authentication (cookie):
Api Key Authentication (bearer):

import semaphore_api
from semaphore_api.models.project_project_id_users_user_id_put_request import ProjectProjectIdUsersUserIdPutRequest
from semaphore_api.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: bearer
configuration.api_key['bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with semaphore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = semaphore_api.DefaultApi(api_client)
    project_id = 1 # int | Project ID
    user_id = 2 # int | User ID
    project_user = semaphore_api.ProjectProjectIdUsersUserIdPutRequest() # ProjectProjectIdUsersUserIdPutRequest | 

    try:
        # Update user role
        api_instance.project_project_id_users_user_id_put(project_id, user_id, project_user)
    except Exception as e:
        print("Exception when calling DefaultApi->project_project_id_users_user_id_put: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	Project ID
user_id	int	User ID
project_user	ProjectProjectIdUsersUserIdPutRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	User updated	-

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

ws_get

ws_get()

Websocket handler

Example

Api Key Authentication (cookie):
Api Key Authentication (bearer):

import semaphore_api
from semaphore_api.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: bearer
configuration.api_key['bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['bearer'] = 'Bearer'

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

    try:
        # Websocket handler
        api_instance.ws_get()
    except Exception as e:
        print("Exception when calling DefaultApi->ws_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-
401	not authenticated	-

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

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

semaphore_api.DefaultApi

events_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

events_last_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

info_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ping_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

project_project_id_users_user_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ws_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details