Registry Onboarding

APIs for managing Registry Onboarding

Create a registry connector

post

Creates a new registry connector for based on the provided details.

Required license:
Cortex Cloud Posture Management or Cortex Cloud Runtime Security.

Header parameters

AuthorizationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Body

connector_idstringOptional

The connector ID.

vendorstring · enumRequired

Name of the registry vendor.

Possible values:

namestringRequired

Name of the registry connector.

enabledbooleanOptional

Indicates whether the connector is enabled.

Default: true

urlstringRequired

The URL of the registry.

usernamestringRequired

The username for authentication.

passwordstringRequired

The password for authentication.

auth_tokenstringRequired

Token to authenticate the request.

scanning_modestring · enumRequired

The scanning mode used by the connector

Possible values:

cloud_providerstring · enumOptional

Specifies the cloud provider for the Cortex environment to use for registry scanning.

Possible values:

outpost_idstringOptional

The outpost ID.

regionstringRequired

Specifies the region to use for registry scanning. As a best practice, choose the region closest to your registry deployment to achieve the best scanning throughput and potentially reduce cloud costs.

insecure_pullbooleanRequired

When set to true, allows image pulls from insecure registries.

ca_certificatestringOptional

Optional. The CA certificate used for authentication.

repositorystringOptional

Optional. The repository used for image discovery.

allow_static_ipsbooleanOptional

Optional. Indicates whether static IP addresses are allowed.

ip_identifierstringOptional

Optional. The identifier associated with the IP address.

asset_scope_filtersone ofOptional

Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied.

registry_typestring · enumOptional

The type of registry.

Possible values:

tenant_idstringOptional

The tenant ID

broker_typestring · enumOptional

Indicates the Broker VM type used by the Outpost.

Possible values:

broker_idstringOptional

The broker ID.

filter_typestring · enumOptionalPossible values:

vendor_specific_configurationone ofOptional

Vendor specific configuration options for scanning.

Responses

201

Connector details have been stored successfully.

application/json

connector_idstringRequired

400

Client error

application/json; charset=UTF-8

500

Service had unexpected internal error

application/json; charset=UTF-8

post/public_api/v1/cwp/registry_onboarding/instances

POST /public_api/v1/cwp/registry_onboarding/instances HTTP/1.1
Host: api-yourfqdn
Authorization: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP 
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 658

{
  "connector_id": "text",
  "vendor": "DOCKER",
  "name": "text",
  "enabled": true,
  "url": "text",
  "username": "text",
  "password": "text",
  "auth_token": "text",
  "scanning_mode": "CLOUD",
  "cloud_provider": "AWS",
  "outpost_id": "text",
  "region": "text",
  "insecure_pull": true,
  "ca_certificate": "text",
  "repository": "text",
  "initial_scan_configuration": {
    "mode": "TAGS_MODIFIED_DAYS",
    "numDays": 7
  },
  "allow_static_ips": true,
  "ip_identifier": "text",
  "asset_scope_filters": {
    "AND": [
      {}
    ]
  },
  "registry_type": "CLOUD_HOSTED",
  "tenant_id": "text",
  "broker_type": "BROKER_VM",
  "broker_id": "text",
  "filter_type": "INCLUDE",
  "vendor_specific_configuration": {
    "group_ids": "text",
    "project_ids": "text",
    "api_domain_name": "text"
  }
}

{
  "connector_id": "text"
}

Get a registry connector

get

Retrieves a registry connector details using its unique ID.

Required license:
Cortex Cloud Posture Management or Cortex Cloud Runtime Security.

Path parameters

connectorIDstringRequired

The unique identifier for the connector.

Header parameters

AuthenticationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

200

Connector details retrieved successfully.

application/json

connector_idstringOptional

The connector ID.

vendorstring · enumOptional

Name of the registry vendor.

Possible values:

namestringOptional

The name of the registry connector.

enabledbooleanOptional

Indicates whether the connector is enabled.

Default: true

urlstringOptional

The URL of the registry.

usernamestringOptional

The username for authentication.

passwordstringOptional

The password for authentication.

auth_tokenstringOptional

Authentication token used to authorize requests to the API.

scanning_modestring · enumOptional

The scanning mode used by the connector

Possible values:

cloud_providerstring · enumOptional

Specifies the cloud provider for the Cortex environment to use for registry scanning.

Possible values:

outpost_idstringOptional

The outpost ID.

regionstringOptional

The region of the connector.

insecure_pullbooleanOptional

When set to true, allows image pulls from insecure registries.

ca_certificatestringOptional

Optional. The CA certificate used for authentication.

repositorystringOptional

Optional. The repository used for image discovery.

allow_static_ipsbooleanOptional

Optional. Indicates whether static IP addresses are allowed.

ip_identifierstringOptional

Optional. The identifier associated with the IP address.

asset_scope_filtersone ofOptional

Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied.

registry_typestring · enumOptional

The type of registry.

Possible values:

tenant_idstringOptional

The tenant ID

broker_typestring · enumOptional

Indicates the Broker VM type used by the Outpost.

Possible values:

broker_idstringOptional

The broker ID.

filter_typestring · enumOptionalPossible values:

vendor_specific_configurationone ofOptional

Vendor specific configuration options for scanning.

404

Connector not found.

application/json

500

Service had unexpected internal error.

application/json

get/public_api/v1/cwp/registry_onboarding/instances/{connectorID}

GET /public_api/v1/cwp/registry_onboarding/instances/{connectorID} HTTP/1.1
Host: api-yourfqdn
Authentication: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-id: 241
Accept: */*

{
  "connector_id": "text",
  "vendor": "DOCKER",
  "name": "text",
  "enabled": true,
  "url": "text",
  "username": "text",
  "password": "text",
  "auth_token": "text",
  "scanning_mode": "CLOUD",
  "cloud_provider": "AWS",
  "outpost_id": "text",
  "region": "text",
  "insecure_pull": true,
  "ca_certificate": "text",
  "repository": "text",
  "initial_scan_configuration": {
    "mode": "TAGS_MODIFIED_DAYS",
    "numDays": 7
  },
  "allow_static_ips": true,
  "ip_identifier": "text",
  "asset_scope_filters": {
    "AND": [
      {}
    ]
  },
  "registry_type": "CLOUD_HOSTED",
  "tenant_id": "text",
  "broker_type": "BROKER_VM",
  "broker_id": "text",
  "filter_type": "INCLUDE",
  "vendor_specific_configuration": {
    "group_ids": "text",
    "project_ids": "text",
    "api_domain_name": "text"
  }
}

Update a registry connector

put

Updates the attributes of an existing registry connector identified by its unique ID.

Required license:
Cortex Cloud Posture Management or Cortex Cloud Runtime Security.

Path parameters

connectorIDstringRequired

The unique identifier for the connector.

Header parameters

AuthenticationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Body

connector_idstringOptional

The connector ID.

vendorstring · enumRequired

Name of the registry vendor.

Possible values:

namestringRequired

Name of the registry connector.

enabledbooleanOptional

Indicates whether the connector is enabled.

Default: true

urlstringRequired

The URL of the registry.

usernamestringRequired

The username for authentication.

passwordstringRequired

The password for authentication.

auth_tokenstringRequired

Token to authenticate the request.

scanning_modestring · enumRequired

The scanning mode used by the connector

Possible values:

cloud_providerstring · enumOptional

Specifies the cloud provider for the Cortex environment to use for registry scanning.

Possible values:

outpost_idstringOptional

The outpost ID.

regionstringRequired

insecure_pullbooleanRequired

When set to true, allows image pulls from insecure registries.

ca_certificatestringOptional

Optional. The CA certificate used for authentication.

repositorystringOptional

Optional. The repository used for image discovery.

allow_static_ipsbooleanOptional

Optional. Indicates whether static IP addresses are allowed.

ip_identifierstringOptional

Optional. The identifier associated with the IP address.

asset_scope_filtersone ofOptional

Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied.

registry_typestring · enumOptional

The type of registry.

Possible values:

tenant_idstringOptional

The tenant ID

broker_typestring · enumOptional

Indicates the Broker VM type used by the Outpost.

Possible values:

broker_idstringOptional

The broker ID.

filter_typestring · enumOptionalPossible values:

vendor_specific_configurationone ofOptional

Vendor specific configuration options for scanning.

Responses

204

Connector details have been updated successfully.

application/json

connector_idstringRequired

400

Client error

application/json; charset=UTF-8

404

Connector ID not found

application/json; charset=UTF-8

500

Service had unexpected internal error

application/json; charset=UTF-8

put/public_api/v1/cwp/registry_onboarding/instances/{connectorID}

PUT /public_api/v1/cwp/registry_onboarding/instances/{connectorID} HTTP/1.1
Host: api-yourfqdn
Authentication: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-id: 241
Content-Type: application/json
Accept: */*
Content-Length: 658

{
  "connector_id": "text",
  "vendor": "DOCKER",
  "name": "text",
  "enabled": true,
  "url": "text",
  "username": "text",
  "password": "text",
  "auth_token": "text",
  "scanning_mode": "CLOUD",
  "cloud_provider": "AWS",
  "outpost_id": "text",
  "region": "text",
  "insecure_pull": true,
  "ca_certificate": "text",
  "repository": "text",
  "initial_scan_configuration": {
    "mode": "TAGS_MODIFIED_DAYS",
    "numDays": 7
  },
  "allow_static_ips": true,
  "ip_identifier": "text",
  "asset_scope_filters": {
    "AND": [
      {}
    ]
  },
  "registry_type": "CLOUD_HOSTED",
  "tenant_id": "text",
  "broker_type": "BROKER_VM",
  "broker_id": "text",
  "filter_type": "INCLUDE",
  "vendor_specific_configuration": {
    "group_ids": "text",
    "project_ids": "text",
    "api_domain_name": "text"
  }
}

{
  "connector_id": "text"
}

Delete a registry connector

delete

Deletes a specific registry connector identified by its unique ID.

Required license:
Cortex Cloud Posture Management or Cortex Cloud Runtime Security.

Path parameters

connectorIDstringRequired

The unique identifier for the connector.

Header parameters

AuthenticationstringRequired

{api_key}

Example:

UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP

x-xdr-auth-idstringRequired

{api_key_id}

Example: 241

Responses

204

Connector deleted successfully.

No content

404

Connector not found.

application/json

500

Service had unexpected internal error.

application/json

delete/public_api/v1/cwp/registry_onboarding/instances/{connectorID}

DELETE /public_api/v1/cwp/registry_onboarding/instances/{connectorID} HTTP/1.1
Host: api-yourfqdn
Authentication: UCoWpG4rkNzgCp2dsh8m02iVpZsskwKHz7N1tErPcUV3Wmf59Gc9kytmgOv0pDWoem3PBlORyRIPiir4OcYdWUOWAM3JyTgoCxQf4nQoTlKmFRKz9Bj5vIjluw66p9WP
x-xdr-auth-id: 241
Accept: */*

No content

PreviousSBOM

NextModels

Last updated 1 month ago

Was this helpful?