castomAPI
Odbierz klucz
POST /v1/git/repositories/{owner}/{repo}/branches/protection 1 token Klucz API GitHub i GitLab

Nakłada reguły ochrony branchy: wymagane zatwierdzenia

Nakłada reguły ochrony branchy: wymagane zatwierdzenia, wymagane status checks, force-push i egzekwowanie dla adminów —

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź 

{
  "action": "created",
  "branch": "<branch>",
  "ignored": [
    "<ignored>"
  ],
  "protection": {},
  "provider": "castomapi",
  "status": "success",
  "tokensDeducted": 1
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Nakłada reguły ochrony branchy: wymagane zatwierdzenia, wymagane status checks, force-push i egzekwowanie dla adminów —

Żądanie

Parametry

PoleWTypWymaganeOpis
ownerpathstringtak
repopathstringtak
x-git-providerheaderenumnie

Treść

PoleTypWymaganeOpis
allowForcePushbooleannie
branchstringtak
enforceAdminsbooleannieGitHub only — GitLab expresses protection purely as access levels
requiredApprovalsintegernieGitHub only — GitLab has no approval count on branch protection (approval rules are a separate, paid-tier resource), so this is reported back in "ignored" rather than applied
requiredStatusChecksarray<string>nieGitHub only — GitLab enforces pipeline success through project merge settings, not branch protection

Przykładowe żądanie

{
  "allowForcePush": true,
  "branch": "<branch>",
  "enforceAdmins": true,
  "requiredApprovals": 6,
  "requiredStatusChecks": [
    "<required status check>"
  ]
}

Odpowiedź

PoleTypOpis
actionenumGitLab distinguishes "created" from "updated" because it refuses to re-protect a branch, which tells us which happened. GitHub replaces existing protection and answers identically either way, so its result is reported as "applied" rather than guessed at One of: created, updated, applied.
branchstring
ignoredarray<string>Fields the caller supplied that this provider cannot express, and which were therefore not applied
protectionobject
providerstring
statusstring
tokensDeductedinteger

Przykładowa odpowiedź

{
  "action": "created",
  "branch": "<branch>",
  "ignored": [
    "<ignored>"
  ],
  "protection": {},
  "provider": "castomapi",
  "status": "success",
  "tokensDeducted": 1
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/git/repositories/{owner}/{repo}/branches/protection' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"allowForcePush": true, "branch": "<branch>", "enforceAdmins": true, "requiredApprovals": 6, "requiredStatusChecks": ["<required status check>"]}'
const res = await fetch('https://app.castomapi.com/v1/git/repositories/{owner}/{repo}/branches/protection', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"allowForcePush": true, "branch": "<branch>", "enforceAdmins": true, "requiredApprovals": 6, "requiredStatusChecks": ["<required status check>"]})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/git/repositories/{owner}/{repo}/branches/protection', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"allowForcePush": true, "branch": "<branch>", "enforceAdmins": true, "requiredApprovals": 6, "requiredStatusChecks": ["<required status check>"]})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/git/repositories/{owner}/{repo}/branches/protection',
    headers={'x-api-key': '<your-api-key>'},
    json={"allowForcePush": True, "branch": "<branch>", "enforceAdmins": True, "requiredApprovals": 6, "requiredStatusChecks": ["<required status check>"]},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/git/repositories/{owner}/{repo}/branches/protection');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['allowForcePush' => true, 'branch' => '<branch>', 'enforceAdmins' => true, 'requiredApprovals' => 6, 'requiredStatusChecks' => ['<required status check>']]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje 1 token. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Nakłada reguły ochrony branchy: wymagane zatwierdzenia?

1 token za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json