curl --request POST \
--url https://api.agenhq.com/api/v1/code-providers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"platform": "gitlab",
"name": "<string>",
"base_url": "<string>",
"metadata": {
"type": "gitlab_personal_access_token",
"token": "<string>"
}
}
'import requests
url = "https://api.agenhq.com/api/v1/code-providers"
payload = {
"platform": "gitlab",
"name": "<string>",
"base_url": "<string>",
"metadata": {
"type": "gitlab_personal_access_token",
"token": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platform: 'gitlab',
name: '<string>',
base_url: '<string>',
metadata: {type: 'gitlab_personal_access_token', token: '<string>'}
})
};
fetch('https://api.agenhq.com/api/v1/code-providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.agenhq.com/api/v1/code-providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'platform' => 'gitlab',
'name' => '<string>',
'base_url' => '<string>',
'metadata' => [
'type' => 'gitlab_personal_access_token',
'token' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.agenhq.com/api/v1/code-providers"
payload := strings.NewReader("{\n \"platform\": \"gitlab\",\n \"name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"metadata\": {\n \"type\": \"gitlab_personal_access_token\",\n \"token\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.agenhq.com/api/v1/code-providers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platform\": \"gitlab\",\n \"name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"metadata\": {\n \"type\": \"gitlab_personal_access_token\",\n \"token\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agenhq.com/api/v1/code-providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platform\": \"gitlab\",\n \"name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"metadata\": {\n \"type\": \"gitlab_personal_access_token\",\n \"token\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspace_id": "<string>",
"user_id": "<string>",
"platform": "gitlab",
"name": "<string>",
"base_url": "<string>",
"metadata": {
"type": "gitlab_personal_access_token",
"token": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"code": "<string>",
"error": "<string>",
"message": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Create code providers
Creates a new code providers.
Required API key scopes: any of code-providers:write, code-providers:all, all:write, all:all.
curl --request POST \
--url https://api.agenhq.com/api/v1/code-providers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"platform": "gitlab",
"name": "<string>",
"base_url": "<string>",
"metadata": {
"type": "gitlab_personal_access_token",
"token": "<string>"
}
}
'import requests
url = "https://api.agenhq.com/api/v1/code-providers"
payload = {
"platform": "gitlab",
"name": "<string>",
"base_url": "<string>",
"metadata": {
"type": "gitlab_personal_access_token",
"token": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platform: 'gitlab',
name: '<string>',
base_url: '<string>',
metadata: {type: 'gitlab_personal_access_token', token: '<string>'}
})
};
fetch('https://api.agenhq.com/api/v1/code-providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.agenhq.com/api/v1/code-providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'platform' => 'gitlab',
'name' => '<string>',
'base_url' => '<string>',
'metadata' => [
'type' => 'gitlab_personal_access_token',
'token' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.agenhq.com/api/v1/code-providers"
payload := strings.NewReader("{\n \"platform\": \"gitlab\",\n \"name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"metadata\": {\n \"type\": \"gitlab_personal_access_token\",\n \"token\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.agenhq.com/api/v1/code-providers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platform\": \"gitlab\",\n \"name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"metadata\": {\n \"type\": \"gitlab_personal_access_token\",\n \"token\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agenhq.com/api/v1/code-providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platform\": \"gitlab\",\n \"name\": \"<string>\",\n \"base_url\": \"<string>\",\n \"metadata\": {\n \"type\": \"gitlab_personal_access_token\",\n \"token\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspace_id": "<string>",
"user_id": "<string>",
"platform": "gitlab",
"name": "<string>",
"base_url": "<string>",
"metadata": {
"type": "gitlab_personal_access_token",
"token": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"code": "<string>",
"error": "<string>",
"message": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Body
Fields used to create a code provider connection.
"gitlab"A human-readable name for the connected code provider account.
The base URL Agen should use to talk to the code hosting platform API.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Response
A code provider connection configured for a workspace.
A code provider connection configured for a workspace.
The unique identifier of the code provider connection inside Agen.
The workspace that owns this code provider connection.
The user who connected this code provider account.
"gitlab"A human-readable name for the connected code provider account.
The base URL Agen should use to talk to the code hosting platform API.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
When the code provider connection was created in Agen.
When the code provider connection was last updated in Agen.