trailofbits-buttercup/orchestrator/docs/RequestApi.md

competition_api_client.RequestApi

All URIs are relative to http://localhost

Method	HTTP request	Description
v1_request_challenge_name_post	POST /v1/request/{challenge_name}	Send a task to the source of this request
v1_request_list_get	GET /v1/request/list/	Get a list of available challenges to task

v1_request_challenge_name_post

TypesMessage v1_request_challenge_name_post(challenge_name, payload)

Send a task to the source of this request

Send a task to the source of this request

Example

• Basic Authentication (BasicAuth):

import competition_api_client
from buttercup.orchestrator.competition_api_client.models.types_message import TypesMessage
from buttercup.orchestrator.competition_api_client.models.types_request_submission import TypesRequestSubmission
from buttercup.orchestrator.competition_api_client.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: BasicAuth
configuration = competition_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with competition_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = competition_api_client.RequestApi(api_client)
    challenge_name = 'challenge_name_example' # str | Challenge Name
    payload = competition_api_client.TypesRequestSubmission() # TypesRequestSubmission | Submission Body

    try:
        # Send a task to the source of this request
        api_response = api_instance.v1_request_challenge_name_post(challenge_name, payload)
        print("The response of RequestApi->v1_request_challenge_name_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RequestApi->v1_request_challenge_name_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
challenge_name	str	Challenge Name
payload	TypesRequestSubmission	Submission Body

Return type

TypesMessage

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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

v1_request_list_get

TypesRequestListResponse v1_request_list_get()

Get a list of available challenges to task

Get a list of available challenges to task

Example

• Basic Authentication (BasicAuth):

import competition_api_client
from buttercup.orchestrator.competition_api_client.models.types_request_list_response import TypesRequestListResponse
from buttercup.orchestrator.competition_api_client.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: BasicAuth
configuration = competition_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

    try:
        # Get a list of available challenges to task
        api_response = api_instance.v1_request_list_get()
        print("The response of RequestApi->v1_request_list_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RequestApi->v1_request_list_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TypesRequestListResponse

Authorization

BasicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
500	Internal Server Error	-

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