This repository has been archived on 2026-01-06. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
vieter/docs/api/source/index.html.md

833 B

title language_tabs toc_footers includes search code_clipboard meta
API Reference
shell
cURL
<a href='https://github.com/slatedocs/slate'>Documentation Powered by Slate</a>
repository
targets
logs
jobs
true true
name content
description Documentation for the Vieter API

Introduction

Welcome to the Vieter API documentation! Here, you can find everything related to interacting with Vieter's HTTP API.

Authentication

curl -H 'X-Api-Key: secret' https://example.com/api/some/path

Don't forget to replace secret with your Vieter instance's secret.

Authentication is done by passing the HTTP header X-Api-Key: secret along with each request, where secret is replaced with your Vieter server's configured secret.