---
title: "CreateRuleSetImport"
method: POST
path: "/v1/namespaces/{tenant_meta.namespace}/rule-set-imports"
tags: ["RuleSetImportService"]
---

# CreateRuleSetImport

`POST /v1/namespaces/{tenant_meta.namespace}/rule-set-imports`

Imports the given set of rules.

## Path parameters

- `tenant_meta.namespace` string, required

## Request body

- RuleSetImportServiceCreateRuleSetImportBody — ImportedRuleSet represents a request to import a set of rules.
  - `meta` V1Meta, required — Common fields for all Endor Labs resources.
    - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
    - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
    - `description` string — Resource description. Must be less than 1024 bytes.
    - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object.
      - `data` string[]
      - `search_score` number, float — search_score is the score of the resource for search. Internal use only.
      - `tenant` string
      - `will_be_deleted_at` string, date-time — Time that the resource will be deleted.
    - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
    - `name` string, required — Resource name. Must be 63 characters or less.
    - `parent_kind` string — Parent object resource kind, for example, Project.
    - `parent_uuid` string — Parent object UUID.
    - `references` object — Map of objects referenced in a query API.
    - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
    - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
    - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `version` string — Message version.
  - `spec` V1ImportedRuleSetSpec — The internal specification of the object.
    - `bytes` string, byte — A file has been used as a source.
    - `opengrep_validate` boolean — Validate this import request with opengrep.
    - `result` SpecImportedRuleSetResult
      - `errors` string[] — Any errors encountered during the operation.
      - `processing_time` number, float — The total time in seconds that it took to process the request.
      - `status` 'IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED' | 'IMPORTED_RULE_SET_RESULT_STATUS_SUCCESS' | 'IMPORTED_RULE_SET_RESULT_STATUS_FAIL'
    - `rule_source_type` 'RULE_SOURCE_TYPE_UNSPECIFIED' | 'RULE_SOURCE_TYPE_ZIP' | 'RULE_SOURCE_TYPE_TAR' | 'RULE_SOURCE_TYPE_ZSTD' | 'RULE_SOURCE_TYPE_GZIP' — The source type of the rule set.
    - `rule_type` 'RULE_TYPE_UNSPECIFIED' | 'RULE_TYPE_SEMGREP' | 'RULE_TYPE_SAST', required
    - `sha256_hash` string — The SHA256 checksum if applicable (e.g, file).
    - `version` string — The version for this rule set. All rules in the set will be created with this version.
  - `tenant_meta` object — Rule set is associated with a tenant and tenant information must be provided.
  - `uuid` string — The UUID of the object.

## Response `200`

A successful response.

- V1ImportedRuleSet — ImportedRuleSet represents a request to import a set of rules.
  - `meta` V1Meta, required — Common fields for all Endor Labs resources.
    - `annotations` object — Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller.
    - `create_time` string, date-time — Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `created_by` string — Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key.
    - `description` string — Resource description. Must be less than 1024 bytes.
    - `index_data` V1IndexData — IndexData is used to index the resource for search. It's an internal object.
      - `data` string[]
      - `search_score` number, float — search_score is the score of the resource for search. Internal use only.
      - `tenant` string
      - `will_be_deleted_at` string, date-time — Time that the resource will be deleted.
    - `kind` string — Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name().
    - `name` string, required — Resource name. Must be 63 characters or less.
    - `parent_kind` string — Parent object resource kind, for example, Project.
    - `parent_uuid` string — Parent object UUID.
    - `references` object — Map of objects referenced in a query API.
    - `tags` string[] — List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less.
    - `update_time` string, date-time — Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `updated_by` string — Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509.
    - `upsert_time` string, date-time — Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt.
    - `version` string — Message version.
  - `spec` V1ImportedRuleSetSpec — The internal specification of the object.
    - `bytes` string, byte — A file has been used as a source.
    - `opengrep_validate` boolean — Validate this import request with opengrep.
    - `result` SpecImportedRuleSetResult
      - `errors` string[] — Any errors encountered during the operation.
      - `processing_time` number, float — The total time in seconds that it took to process the request.
      - `status` 'IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED' | 'IMPORTED_RULE_SET_RESULT_STATUS_SUCCESS' | 'IMPORTED_RULE_SET_RESULT_STATUS_FAIL'
    - `rule_source_type` 'RULE_SOURCE_TYPE_UNSPECIFIED' | 'RULE_SOURCE_TYPE_ZIP' | 'RULE_SOURCE_TYPE_TAR' | 'RULE_SOURCE_TYPE_ZSTD' | 'RULE_SOURCE_TYPE_GZIP' — The source type of the rule set.
    - `rule_type` 'RULE_TYPE_UNSPECIFIED' | 'RULE_TYPE_SEMGREP' | 'RULE_TYPE_SAST', required
    - `sha256_hash` string — The SHA256 checksum if applicable (e.g, file).
    - `version` string — The version for this rule set. All rules in the set will be created with this version.
  - `tenant_meta` V1TenantMeta — Tenant related data for the tenant containing the resource.
    - `namespace` string, required — Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app".
  - `uuid` string — The UUID of the object.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference.md) · [All operations](https://skmtc.net/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/endorlabs/endor-labs-rest-api-reference/versions/2fe1f84213b3/schema)