51장. 정책 서비스
51.1. 정책 서비스
51.1.1. CancelDryRunJob
DELETE /v1/policies/dryrunjob/{jobId}
51.1.1.1. 설명
51.1.1.2. 매개 변수
51.1.1.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| jobId | X | null |
51.1.1.3. 반환 유형
개체
51.1.1.4. 콘텐츠 유형
- application/json
51.1.1.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
51.1.1.6. Samples
51.1.2. DeletePolicy
DELETE /v1/policies/{id}
DeletePolicy는 ID별 정책을 제거합니다.
51.1.2.1. 설명
51.1.2.2. 매개 변수
51.1.2.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
51.1.2.3. 반환 유형
개체
51.1.2.4. 콘텐츠 유형
- application/json
51.1.2.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
51.1.2.6. Samples
51.1.3. DryRunPolicy
POST /v1/policies/dryrun
DryRunPolicy는 지정된 정책을 평가하고 정책을 생성하지 않고 경고를 반환합니다.
51.1.3.1. 설명
51.1.3.2. 매개 변수
51.1.3.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.3.3. 반환 유형
51.1.3.4. 콘텐츠 유형
- application/json
51.1.3.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.3.6. Samples
51.1.4. EnableDisablePolicyNotification
PATCH /v1/policies/{policyId}/notifiers
EnableDisablePolicyNotification은 ID별 정책에 대한 알림을 활성화하거나 비활성화합니다.
51.1.4.1. 설명
51.1.4.2. 매개 변수
51.1.4.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| policyId | X | null |
51.1.4.2.2. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.4.3. 반환 유형
개체
51.1.4.4. 콘텐츠 유형
- application/json
51.1.4.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
51.1.4.6. Samples
51.1.5. ExportPolicies
POST /v1/policies/export
ExportPolicies는 정책 ID 목록을 사용하고 전체 정책 목록 또는 오류 메시지를 반환합니다.
51.1.5.1. 설명
51.1.5.2. 매개 변수
51.1.5.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.5.3. 반환 유형
51.1.5.4. 콘텐츠 유형
- application/json
51.1.5.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.5.6. Samples
51.1.6. GetPolicy
GET /v1/policies/{id}
GetPolicy는 ID로 요청된 정책을 반환합니다.
51.1.6.1. 설명
51.1.6.2. 매개 변수
51.1.6.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
51.1.6.3. 반환 유형
51.1.6.4. 콘텐츠 유형
- application/json
51.1.6.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.6.6. Samples
51.1.7. GetPolicyCategories
GET /v1/policyCategories
GetPolicyCategories는 정책 범주를 반환합니다.
51.1.7.1. 설명
51.1.7.2. 매개 변수
51.1.7.3. 반환 유형
51.1.7.4. 콘텐츠 유형
- application/json
51.1.7.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.7.6. Samples
51.1.8. GetPolicyMitreVectors
GET /v1/policies/{id}/mitrevectors
GetMitreVectorsForPolicy는 ID로 요청된 정책을 반환합니다.
51.1.8.1. 설명
51.1.8.2. 매개 변수
51.1.8.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
51.1.8.2.2. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| options.excludePolicy | true로 설정하면 정책이 응답에서 제외됩니다. | - | null |
51.1.8.3. 반환 유형
51.1.8.4. 콘텐츠 유형
- application/json
51.1.8.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.8.6. Samples
51.1.9. ImportPolicies
POST /v1/policies/import
ImportPolicies는 정책 목록을 수락하고 가져올 수 없는 정책 목록을 반환합니다.
51.1.9.1. 설명
51.1.9.2. 매개 변수
51.1.9.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.9.3. 반환 유형
51.1.9.4. 콘텐츠 유형
- application/json
51.1.9.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.9.6. Samples
51.1.10. ListPolicies
GET /v1/policies
ListPolicies는 정책 목록을 반환합니다.
51.1.10.1. 설명
51.1.10.2. 매개 변수
51.1.10.2.1. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | 설정되지 않음 | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
51.1.10.3. 반환 유형
51.1.10.4. 콘텐츠 유형
- application/json
51.1.10.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.10.6. Samples
51.1.11. PatchPolicy
PATCH /v1/policies/{id}
PatchPolicy는 기존 정책을 편집합니다.
51.1.11.1. 설명
51.1.11.2. 매개 변수
51.1.11.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
51.1.11.2.2. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.11.3. 반환 유형
개체
51.1.11.4. 콘텐츠 유형
- application/json
51.1.11.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
51.1.11.6. Samples
51.1.12. PolicyFromSearch
POST /v1/policies/from-search
51.1.12.1. 설명
51.1.12.2. 매개 변수
51.1.12.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.12.3. 반환 유형
51.1.12.4. 콘텐츠 유형
- application/json
51.1.12.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.12.6. Samples
51.1.13. PostPolicy
POST /v1/policies
PostPolicy는 새 정책을 생성합니다.
51.1.13.1. 설명
51.1.13.2. 매개 변수
51.1.13.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| policy | X |
51.1.13.2.2. 쿼리 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| enableStrictValidation | - | null |
51.1.13.3. 반환 유형
51.1.13.4. 콘텐츠 유형
- application/json
51.1.13.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.13.6. Samples
51.1.14. PutPolicy
PUT /v1/policies/{id}
PutPolicy는 기존 정책을 수정합니다.
51.1.14.1. 설명
51.1.14.2. 매개 변수
51.1.14.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| id | X | null |
51.1.14.2.2. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.14.3. 반환 유형
개체
51.1.14.4. 콘텐츠 유형
- application/json
51.1.14.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
51.1.14.6. Samples
51.1.15. QueryDryRunJobStatus
GET /v1/policies/dryrunjob/{jobId}
51.1.15.1. 설명
51.1.15.2. 매개 변수
51.1.15.2.1. 경로 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| jobId | X | null |
51.1.15.3. 반환 유형
51.1.15.4. 콘텐츠 유형
- application/json
51.1.15.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
51.1.15.6. Samples
51.1.16. ReassessPolicies
POST /v1/policies/reassess
ReassessPolicies는 모든 정책을 재평가합니다.
51.1.16.1. 설명
51.1.16.2. 매개 변수
51.1.16.3. 반환 유형
개체
51.1.16.4. 콘텐츠 유형
- application/json
51.1.16.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. |
|
| 0 | 예기치 않은 오류 응답 |
51.1.16.6. Samples
51.1.17. SubmitDryRunPolicyJob
POST /v1/policies/dryrunjob
51.1.17.1. 설명
51.1.17.2. 매개 변수
51.1.17.2.1. 본문 매개변수
| 이름 | 설명 | 필수 항목 | 기본 | 패턴 |
|---|---|---|---|---|
| body | X |
51.1.17.3. 반환 유형
51.1.17.4. 콘텐츠 유형
- application/json
51.1.17.5. 응답
| 코드 | 메시지 | datatype |
|---|---|---|
| 200 | 성공적인 응답입니다. | |
| 0 | 예기치 않은 오류 응답 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}