Organisations
Set an organisation's secret scanning
Warn, or block a publish to the library (publish, auto-publish, editor save, public share) that has what looks like a secret, with 422 orgs.publish_blocked listing every finding masked.
PUT
/orgs/{org}/secret-scanningTL;DR
| Question | Answer |
|---|---|
| What does it do? | Set an organisation's secret scanning. |
| What does it take? | A JSON body of type SecretScanning. |
| What does it return? | Status 200 with a body of type SecretScanning. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 only the owner or an admin may change it (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, or the caller is not a member of it; 422 a hostname pattern cannot be used; the details name each one and why; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Warn, or block a publish to the library (publish, auto-publish, editor save, public share) that has what looks like a secret, with 422 orgs.publish_blocked listing every finding masked. Private addresses and hostname patterns are off by default and count only under block. Pattern-based, not a guarantee. The owner or an admin.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type SecretScanning.
| Field | Type | Required | Description |
|---|---|---|---|
mode | "warn" | "block" | yes | warn: a publish to the library goes ahead and every draw warns (W700 to W710). block: a publish, an auto-publish, an editor save or a public share with any finding is refused with 422 orgs.publish_blocked. |
privateIps | boolean | yes | Also count private IPv4 addresses (10/8, 172.16/12, 192.168/16) as findings (W709). Off by default; counts only while mode is block. |
hostPatterns | string[] | yes | Internal hostname patterns that count as findings (W710), such as *.corp.example: DNS names in lower case, with * only as the first label. Empty by default; count only while mode is block. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The setting now. | SecretScanning |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner or an admin may change it (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 422 | A hostname pattern cannot be used; the details name each one and why. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type SecretScanning.
| Field | Type | Required | Description |
|---|---|---|---|
mode | "warn" | "block" | yes | warn: a publish to the library goes ahead and every draw warns (W700 to W710). block: a publish, an auto-publish, an editor save or a public share with any finding is refused with 422 orgs.publish_blocked. |
privateIps | boolean | yes | Also count private IPv4 addresses (10/8, 172.16/12, 192.168/16) as findings (W709). Off by default; counts only while mode is block. |
hostPatterns | string[] | yes | Internal hostname patterns that count as findings (W710), such as *.corp.example: DNS names in lower case, with * only as the first label. Empty by default; count only while mode is block. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |