Create Credential
curl --request POST \
--url https://platform.groundforge.ai/v1/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": {
"ref": "<string>",
"displayName": "<string>"
},
"scope": {
"environments": [
"<string>"
],
"targets": [
{
"kind": "<string>",
"ref": "<string>",
"name": "<string>"
}
],
"metadata": {}
},
"id": "<string>",
"tenantId": "<string>",
"subTenantId": "<string>",
"credentialType": "api_key",
"status": "active",
"secretRef": "<string>",
"expiresAtMs": 123,
"generateSecret": true,
"metadata": {}
}
'import requests
url = "https://platform.groundforge.ai/v1/credentials"
payload = {
"subject": {
"ref": "<string>",
"displayName": "<string>"
},
"scope": {
"environments": ["<string>"],
"targets": [
{
"kind": "<string>",
"ref": "<string>",
"name": "<string>"
}
],
"metadata": {}
},
"id": "<string>",
"tenantId": "<string>",
"subTenantId": "<string>",
"credentialType": "api_key",
"status": "active",
"secretRef": "<string>",
"expiresAtMs": 123,
"generateSecret": True,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject: {ref: '<string>', displayName: '<string>'},
scope: {
environments: ['<string>'],
targets: [{kind: '<string>', ref: '<string>', name: '<string>'}],
metadata: {}
},
id: '<string>',
tenantId: '<string>',
subTenantId: '<string>',
credentialType: 'api_key',
status: 'active',
secretRef: '<string>',
expiresAtMs: 123,
generateSecret: true,
metadata: {}
})
};
fetch('https://platform.groundforge.ai/v1/credentials', 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://platform.groundforge.ai/v1/credentials",
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([
'subject' => [
'ref' => '<string>',
'displayName' => '<string>'
],
'scope' => [
'environments' => [
'<string>'
],
'targets' => [
[
'kind' => '<string>',
'ref' => '<string>',
'name' => '<string>'
]
],
'metadata' => [
]
],
'id' => '<string>',
'tenantId' => '<string>',
'subTenantId' => '<string>',
'credentialType' => 'api_key',
'status' => 'active',
'secretRef' => '<string>',
'expiresAtMs' => 123,
'generateSecret' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://platform.groundforge.ai/v1/credentials"
payload := strings.NewReader("{\n \"subject\": {\n \"ref\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n \"scope\": {\n \"environments\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"kind\": \"<string>\",\n \"ref\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"id\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"subTenantId\": \"<string>\",\n \"credentialType\": \"api_key\",\n \"status\": \"active\",\n \"secretRef\": \"<string>\",\n \"expiresAtMs\": 123,\n \"generateSecret\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://platform.groundforge.ai/v1/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": {\n \"ref\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n \"scope\": {\n \"environments\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"kind\": \"<string>\",\n \"ref\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"id\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"subTenantId\": \"<string>\",\n \"credentialType\": \"api_key\",\n \"status\": \"active\",\n \"secretRef\": \"<string>\",\n \"expiresAtMs\": 123,\n \"generateSecret\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.groundforge.ai/v1/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": {\n \"ref\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n \"scope\": {\n \"environments\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"kind\": \"<string>\",\n \"ref\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"id\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"subTenantId\": \"<string>\",\n \"credentialType\": \"api_key\",\n \"status\": \"active\",\n \"secretRef\": \"<string>\",\n \"expiresAtMs\": 123,\n \"generateSecret\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create Credential
POST
/
v1
/
credentials
Create Credential
curl --request POST \
--url https://platform.groundforge.ai/v1/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": {
"ref": "<string>",
"displayName": "<string>"
},
"scope": {
"environments": [
"<string>"
],
"targets": [
{
"kind": "<string>",
"ref": "<string>",
"name": "<string>"
}
],
"metadata": {}
},
"id": "<string>",
"tenantId": "<string>",
"subTenantId": "<string>",
"credentialType": "api_key",
"status": "active",
"secretRef": "<string>",
"expiresAtMs": 123,
"generateSecret": true,
"metadata": {}
}
'import requests
url = "https://platform.groundforge.ai/v1/credentials"
payload = {
"subject": {
"ref": "<string>",
"displayName": "<string>"
},
"scope": {
"environments": ["<string>"],
"targets": [
{
"kind": "<string>",
"ref": "<string>",
"name": "<string>"
}
],
"metadata": {}
},
"id": "<string>",
"tenantId": "<string>",
"subTenantId": "<string>",
"credentialType": "api_key",
"status": "active",
"secretRef": "<string>",
"expiresAtMs": 123,
"generateSecret": True,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject: {ref: '<string>', displayName: '<string>'},
scope: {
environments: ['<string>'],
targets: [{kind: '<string>', ref: '<string>', name: '<string>'}],
metadata: {}
},
id: '<string>',
tenantId: '<string>',
subTenantId: '<string>',
credentialType: 'api_key',
status: 'active',
secretRef: '<string>',
expiresAtMs: 123,
generateSecret: true,
metadata: {}
})
};
fetch('https://platform.groundforge.ai/v1/credentials', 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://platform.groundforge.ai/v1/credentials",
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([
'subject' => [
'ref' => '<string>',
'displayName' => '<string>'
],
'scope' => [
'environments' => [
'<string>'
],
'targets' => [
[
'kind' => '<string>',
'ref' => '<string>',
'name' => '<string>'
]
],
'metadata' => [
]
],
'id' => '<string>',
'tenantId' => '<string>',
'subTenantId' => '<string>',
'credentialType' => 'api_key',
'status' => 'active',
'secretRef' => '<string>',
'expiresAtMs' => 123,
'generateSecret' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://platform.groundforge.ai/v1/credentials"
payload := strings.NewReader("{\n \"subject\": {\n \"ref\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n \"scope\": {\n \"environments\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"kind\": \"<string>\",\n \"ref\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"id\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"subTenantId\": \"<string>\",\n \"credentialType\": \"api_key\",\n \"status\": \"active\",\n \"secretRef\": \"<string>\",\n \"expiresAtMs\": 123,\n \"generateSecret\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://platform.groundforge.ai/v1/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": {\n \"ref\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n \"scope\": {\n \"environments\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"kind\": \"<string>\",\n \"ref\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"id\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"subTenantId\": \"<string>\",\n \"credentialType\": \"api_key\",\n \"status\": \"active\",\n \"secretRef\": \"<string>\",\n \"expiresAtMs\": 123,\n \"generateSecret\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.groundforge.ai/v1/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subject\": {\n \"ref\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n \"scope\": {\n \"environments\": [\n \"<string>\"\n ],\n \"targets\": [\n {\n \"kind\": \"<string>\",\n \"ref\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n },\n \"id\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"subTenantId\": \"<string>\",\n \"credentialType\": \"api_key\",\n \"status\": \"active\",\n \"secretRef\": \"<string>\",\n \"expiresAtMs\": 123,\n \"generateSecret\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
bearerAuthapiKeyAuth
OIDC access token for users and CLI clients.
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
active, revoked, expired, disabled, archived Response
Successful Response
Last modified on July 29, 2026
⌘I

