# Credential Sets ## List Credential Sets `vulnerability_scanner.credential_sets.list(CredentialSetListParams**kwargs) -> SyncV4PagePaginationArray[CredentialSetListResponse]` **get** `/accounts/{account_id}/vuln_scanner/credential_sets` Returns all credential sets for the account. ### Parameters - `account_id: Optional[str]` Identifier. - `page: Optional[int]` Page number of paginated results. - `per_page: Optional[int]` Number of results per page. ### Returns - `class CredentialSetListResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.vulnerability_scanner.credential_sets.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "Production API credentials" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ## Create Credential Set `vulnerability_scanner.credential_sets.create(CredentialSetCreateParams**kwargs) -> CredentialSetCreateResponse` **post** `/accounts/{account_id}/vuln_scanner/credential_sets` Creates a new credential set. ### Parameters - `account_id: Optional[str]` Identifier. - `name: str` Human-readable name. ### Returns - `class CredentialSetCreateResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential_set = client.vulnerability_scanner.credential_sets.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", name="Production API credentials", ) print(credential_set.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "Production API credentials" }, "result_info": {} } ``` ## Get Credential Set `vulnerability_scanner.credential_sets.get(strcredential_set_id, CredentialSetGetParams**kwargs) -> CredentialSetGetResponse` **get** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}` Returns a single credential set by ID. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` ### Returns - `class CredentialSetGetResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential_set = client.vulnerability_scanner.credential_sets.get( credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(credential_set.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "Production API credentials" }, "result_info": {} } ``` ## Update Credential Set `vulnerability_scanner.credential_sets.update(strcredential_set_id, CredentialSetUpdateParams**kwargs) -> CredentialSetUpdateResponse` **put** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}` Replaces a credential set. All fields must be provided. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `name: str` Human-readable name. ### Returns - `class CredentialSetUpdateResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential_set = client.vulnerability_scanner.credential_sets.update( credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", name="Production API credentials", ) print(credential_set.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "Production API credentials" }, "result_info": {} } ``` ## Edit Credential Set `vulnerability_scanner.credential_sets.edit(strcredential_set_id, CredentialSetEditParams**kwargs) -> CredentialSetEditResponse` **patch** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}` Updates a credential set with only the provided fields; omitted fields remain unchanged. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `name: Optional[str]` Human-readable name. ### Returns - `class CredentialSetEditResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.vulnerability_scanner.credential_sets.edit( credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(response.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "name": "Production API credentials" }, "result_info": {} } ``` ## Delete Credential Set `vulnerability_scanner.credential_sets.delete(strcredential_set_id, CredentialSetDeleteParams**kwargs) -> object` **delete** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}` Deletes a credential set and all of its credentials. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` ### Returns - `object` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential_set = client.vulnerability_scanner.credential_sets.delete( credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(credential_set) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": {}, "result_info": {} } ``` ## Domain Types ### Credential Set List Response - `class CredentialSetListResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Credential Set Create Response - `class CredentialSetCreateResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Credential Set Get Response - `class CredentialSetGetResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Credential Set Update Response - `class CredentialSetUpdateResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. ### Credential Set Edit Response - `class CredentialSetEditResponse: …` - `id: str` Credential set identifier. - `name: str` Human-readable name. # Credentials ## List Credentials `vulnerability_scanner.credential_sets.credentials.list(strcredential_set_id, CredentialListParams**kwargs) -> SyncV4PagePaginationArray[CredentialListResponse]` **get** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials` Returns all credentials within a credential set. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `page: Optional[int]` Page number of paginated results. - `per_page: Optional[int]` Number of results per page. ### Returns - `class CredentialListResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.vulnerability_scanner.credential_sets.credentials.list( credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "location": "header", "location_name": "Authorization", "name": "Admin API key" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ## Create Credential `vulnerability_scanner.credential_sets.credentials.create(strcredential_set_id, CredentialCreateParams**kwargs) -> CredentialCreateResponse` **post** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials` Creates a new credential within a credential set. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. - `value: str` The credential value (e.g. API key, session token). Write-only. Never returned in responses. ### Returns - `class CredentialCreateResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential = client.vulnerability_scanner.credential_sets.credentials.create( credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", location="header", location_name="Authorization", name="Admin API key", value="Bearer EXAMPLE_TOKEN", ) print(credential.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "location": "header", "location_name": "Authorization", "name": "Admin API key" }, "result_info": {} } ``` ## Get Credential `vulnerability_scanner.credential_sets.credentials.get(strcredential_id, CredentialGetParams**kwargs) -> CredentialGetResponse` **get** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}` Returns a single credential by ID. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `credential_id: str` ### Returns - `class CredentialGetResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential = client.vulnerability_scanner.credential_sets.credentials.get( credential_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(credential.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "location": "header", "location_name": "Authorization", "name": "Admin API key" }, "result_info": {} } ``` ## Update Credential `vulnerability_scanner.credential_sets.credentials.update(strcredential_id, CredentialUpdateParams**kwargs) -> CredentialUpdateResponse` **put** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}` Replaces a credential. All fields must be provided. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `credential_id: str` - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. - `value: str` The credential value. Write-only. Never returned in responses. ### Returns - `class CredentialUpdateResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential = client.vulnerability_scanner.credential_sets.credentials.update( credential_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", location="header", location_name="Authorization", name="Admin API key", value="Bearer EXAMPLE_TOKEN", ) print(credential.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "location": "header", "location_name": "Authorization", "name": "Admin API key" }, "result_info": {} } ``` ## Edit Credential `vulnerability_scanner.credential_sets.credentials.edit(strcredential_id, CredentialEditParams**kwargs) -> CredentialEditResponse` **patch** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}` Updates a credential with only the provided fields; omitted fields remain unchanged. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `credential_id: str` - `location: Optional[Literal["header", "cookie"]]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: Optional[str]` Name of the header or cookie where the credential is attached. - `name: Optional[str]` Human-readable name. - `value: Optional[str]` The credential value. Write-only. Never returned in responses. ### Returns - `class CredentialEditResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.vulnerability_scanner.credential_sets.credentials.edit( credential_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(response.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "location": "header", "location_name": "Authorization", "name": "Admin API key" }, "result_info": {} } ``` ## Delete Credential `vulnerability_scanner.credential_sets.credentials.delete(strcredential_id, CredentialDeleteParams**kwargs) -> object` **delete** `/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}` Deletes a credential. ### Parameters - `account_id: Optional[str]` Identifier. - `credential_set_id: str` - `credential_id: str` ### Returns - `object` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) credential = client.vulnerability_scanner.credential_sets.credentials.delete( credential_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", credential_set_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(credential) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": {}, "result_info": {} } ``` ## Domain Types ### Credential List Response - `class CredentialListResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Credential Create Response - `class CredentialCreateResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Credential Get Response - `class CredentialGetResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Credential Update Response - `class CredentialUpdateResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name. ### Credential Edit Response - `class CredentialEditResponse: …` A credential attached to API requests during scanning. The credential `value` is write-only and never returned in responses. - `id: str` Credential identifier. - `credential_set_id: str` Parent credential set identifier. - `location: Literal["header", "cookie"]` Where the credential is attached in outgoing requests. - `"header"` - `"cookie"` - `location_name: str` Name of the header or cookie where the credential is attached. - `name: str` Human-readable name.