A client library for accessing HTB API bindings
First, create a client:
from htb_api_bindings_client import AuthenticatedClient
client = AuthenticatedClient(base_url="https://labs.hackthebox.com/api", token="YOUR_HTB_API_TOKEN")Now call your endpoint and use your models:
from htb_api_bindings_client import AuthenticatedClient
from htb_api_bindings_client.api.default import get_v4_machine_profile_id, get_v4_challenge_info_id
from htb_api_bindings_client.models.get_v4_machine_profile_id_response_200 import GetV4MachineProfileIdResponse200
from htb_api_bindings_client.models.get_v4_challenge_info_id_response_200 import GetV4ChallengeInfoIdResponse200
from htb_api_bindings_client.types import Response
client = AuthenticatedClient(
base_url="https://labs.hackthebox.com/api",
token="YOUR_HTB_API_TOKEN",
)
with client as client:
response1: Response[GetV4MachineProfileIdResponse200] = get_v4_machine_profile_id.sync_detailed(
id="400", client=client
)
print(response1)
response2: Response[GetV4MachineProfileIdResponse200] = get_v4_machine_profile_id.sync_detailed(
id="Ouija", client=client
)
print(response2)
response3: Response[GetV4ChallengeInfoIdResponse200] = get_v4_challenge_info_id.sync_detailed(
id="500", client=client
)
print(response3)
response4: Response[GetV4ChallengeInfoIdResponse200] = get_v4_challenge_info_id.sync_detailed(
id="dudidudida", client=client
)
print(response4)Or do the same thing with an async version:
from htb_api_bindings_client.models import MyDataModel
from htb_api_bindings_client.api.my_tag import get_my_data_model
from htb_api_bindings_client.types import Response
async with client as client:
my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl="/path/to/certificate_bundle.pem",
)You can also disable certificate validation altogether, but beware that this is a security risk.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl=False
)Things to know:
-
Every path/method combo becomes a Python module with four functions:
sync: Blocking request that returns parsed data (if successful) orNonesync_detailed: Blocking request that always returns aRequest, optionally withparsedset if the request was successful.asyncio: Likesyncbut async instead of blockingasyncio_detailed: Likesync_detailedbut async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
Any endpoint which did not have a tag will be in
htb_api_bindings_client.api.default
There are more settings on the generated Client class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying httpx.Client or httpx.AsyncClient (depending on your use-case):
from htb_api_bindings_client import Client
def log_request(request):
print(f"Request event hook: {request.method} {request.url} - Waiting for response")
def log_response(response):
request = response.request
print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
client = Client(
base_url="https://api.example.com",
httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
)
# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
import httpx
from htb_api_bindings_client import Client
client = Client(
base_url="https://api.example.com",
)
# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))