> ## Documentation Index > Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt > Use this file to discover all available pages before exploring further. # List all Mtls Authentication Credentials ## OpenAPI ````json GET /mtls-authentication-credentials { "openapi": "3.0.3", "info": { "title": "VAST DataEngine API", "description": "Combined OpenAPI specification for Document360: Provisioning, Telemetries Query, Telemetries Collector, and shared common components.", "version": "1.4.0" }, "servers": [ { "url": "http://localhost:3000", "description": "Provisioning Service (Local development server)" }, { "url": "http://localhost:8080/query_telemetries", "description": "Telemetries Query Service (Local development server)" }, { "url": "http://localhost:8080/telemetries", "description": "Telemetries Collector Service (Local development server)" } ], "tags": [ { "name": "Provisioning Service v1.4.0", "description": "Provisioning Service API" }, { "name": "Provisioning Service v1.4.0 > dataEngine", "description": "Data Engine lifecycle" }, { "name": "Provisioning Service v1.4.0 > setup_provisioning", "description": "Deprecated provisioning setup" }, { "name": "Provisioning Service v1.4.0 > pipelines", "description": "Pipelines" }, { "name": "Provisioning Service v1.4.0 > pipelineRevisions", "description": "Pipeline revisions" }, { "name": "Provisioning Service v1.4.0 > functions", "description": "Functions" }, { "name": "Provisioning Service v1.4.0 > functionRevisions", "description": "Function revisions" }, { "name": "Provisioning Service v1.4.0 > functionRevisionsDeprecated", "description": "Deprecated function revision endpoints" }, { "name": "Provisioning Service v1.4.0 > triggers", "description": "Triggers" }, { "name": "Provisioning Service v1.4.0 > topics", "description": "Topics" }, { "name": "Provisioning Service v1.4.0 > containerRegistries", "description": "Container registries" }, { "name": "Provisioning Service v1.4.0 > kubernetesClusters", "description": "Kubernetes clusters" }, { "name": "Provisioning Service v1.4.0 > kubernetesSecrets", "description": "Kubernetes secrets" }, { "name": "Provisioning Service v1.4.0 > mtlsAuthenticationCredentials", "description": "mTLS authentication credentials" }, { "name": "Provisioning Service v1.4.0 > dashboard", "description": "Dashboard" }, { "name": "Provisioning Service v1.4.0 > reports", "description": "Saved reports" }, { "name": "Telemetries Collector Service v1.4.0", "description": "API for collecting OTEL signals (traces, logs and metrics)" }, { "name": "Telemetries Collector Service v1.4.0 > collect_telemetries", "description": "Collect OTEL signals" }, { "name": "Telemetries Query Service v1.4.0", "description": "API for querying traces, logs and metrics" }, { "name": "Telemetries Query Service v1.4.0 > query_telemetries", "description": "Query traces and logs" }, { "name": "Telemetries Query Service v1.4.0 > metrics", "description": "Query metrics" }, { "name": "Telemetries Query Service v1.4.0 > reports", "description": "Saved reports" } ], "paths": { "/mtls-authentication-credentials": { "get": { "summary": "List all Mtls Authentication Credentials", "operationId": "listMtlsAuthenticationCredentials", "tags": [ "Provisioning Service v1.4.0 > mtlsAuthenticationCredentials" ], "parameters": [ { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "A list of Mtls Authentication Credentials", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MTLSAuthenticationCredentials" } } } } } } } } } } }, "components": { "parameters": { "Cursor": { "name": "cursor", "in": "query", "required": "false", "schema": { "type": "string" } }, "Limit": { "name": "limit", "in": "query", "required": "false", "schema": { "default": "100", "type": "integer" } }, "OrderBy": { "name": "order_by", "in": "query", "required": "false", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "description": "Sort order - ascending (asc) or descending (desc)" } }, "schemas": { "Pagination": { "allOf": [ { "type": "object", "properties": { "next_cursor": { "type": "string", "description": "The cursor for the next page" }, "previous_cursor": { "type": "string", "description": "The cursor for the last page" } } } ] }, "MTLSAuthenticationCredentials": { "allOf": [ { "$ref": "#/components/schemas/Resource" }, { "$ref": "#/components/schemas/MTLSAuthenticationCredentialsCreate" }, { "type": "object" } ] }, "Resource": { "allOf": [ { "$ref": "#/components/schemas/ResourceCreate" }, { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/ReadOnlyID" }, "guid": { "$ref": "#/components/schemas/ReadOnlyGUID" }, "tenant_guid": { "$ref": "#/components/schemas/TenantID" }, "owner": { "$ref": "#/components/schemas/UserID" }, "created_at": { "type": "string", "readOnly": "true", "format": "date-time", "description": "Timestamp when the resource was created.", "example": "2024-12-25 15:30:00+00:00" }, "updated_at": { "type": "string", "readOnly": "true", "format": "date-time", "description": "Timestamp when the resource was last updated.", "example": "2024-12-28 18:00:00+00:00" }, "vrn": { "$ref": "#/components/schemas/VastRN" } } } ], "description": "Extends ResourceCreate with read-only fields." }, "MTLSAuthenticationCredentialsCreate": { "allOf": [ { "$ref": "#/components/schemas/ResourceCreate" }, { "$ref": "#/components/schemas/MTLSAuthenticationCredentialsUpdate" } ], "required": [ "client_key_b64", "client_certificate_b64", "certificate_authority_b64" ] }, "ResourceCreate": { "allOf": [ { "$ref": "#/components/schemas/ResourceUpdate" } ], "required": [ "name" ] }, "ReadOnlyID": { "type": "integer", "format": "int64", "readOnly": "true", "description": "A globally unique identifier (ID) for the resource." }, "ReadOnlyGUID": { "type": "string", "readOnly": "true", "format": "uuid", "description": "A globally unique identifier (GUID) for the resource.", "example": "a7f4aa24-a00d-4dc5-a113-2031eb8c2c79" }, "TenantID": { "$ref": "#/components/schemas/ReadOnlyGUID" }, "UserID": { "type": "object", "readOnly": "true", "properties": { "id": { "type": "string", "description": "The unique identifier for the owner." }, "id_type": { "type": "string", "description": "The type of identifier for the owner.", "enum": [ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ] }, "name": { "type": "string", "description": "The presentable name of the owner" } }, "required": [ "id", "id_type" ], "description": "Represents the owner of the resource." }, "VastRN": { "type": "string", "description": "A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine::\nwhere resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.\n", "example": "vast:dataengine:functions:foo" }, "MTLSAuthenticationCredentialsUpdate": { "allOf": [ { "$ref": "#/components/schemas/ResourceUpdate" }, { "type": "object", "properties": { "client_key_b64": { "type": "string", "description": "Base64-encoded private key associated with a client certificate.\nIt is used by the Kubernetes client (e.g., kubectl) to prove its identity to the API server when making requests.\nThis key must remain confidential and secure.\n", "example": "LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2QUlCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktZd2dnU2lBZ0VBQW9JQkFRQ1FBUzhORkU4djBQdnYKUUdJRUVkVDl0a3A1NEVyWmFKZlp2Um1RNUpOeURiQTRWTzBGSzhRNkcvRXRKSzR4OW1naDdBb0Mrc3VXYVZBTgpHWk1YTUQ3TUxCbXB4aldLcE9vME9qV3J6MXFxNzl2RUlqZURCYnlzNHlnRjVvS3BIdkptR1BUTitqclZPeXpFCjhrTjVyUVhsaGk3ajdEZnVSTHZiUVFNZ2k4dWw3ZWJUUEZ0eUFtZ01sY011YS9KeTJkMmwyNXo5UEdlZTgyLzEKay9yVlFxSTU3OTFRWG12aGRoSUNqSnk2RDI4NVNWYWlYdCtSTmhOUG5TdzZiWlB2QVNJOW1Say9HVkFiMDROVgo2RWdqQXc4MjN4TGZkU01XSm45Vm03L01OdXNEZURFRHg3Z2hTdldFT2htUWl3dDRGVmFOMittZlhXWWVWeTBQClFKNzhUcGo1QWdNQkFBRUNnZ0VBQWI2d1U4THh2TEI4cTJiNk5kMERjMS96eUhnU0xPaHFiMnJoUXV5d2dlRXUKWVl1T3NONC95eU5DSXlqTGhZemNGNDN1dWxLM0NEUThxOGNxRFpxVGpRVElMWi9BNlZSMDFBaVVJVTZFTWpzSwp6SS9sK2hpL21XbmpuVnhKeFoxdTRYb0ZWaWJMdithdTlPT1B6U1M3UkE4MUVndFZ5MXdBMllURUM5V2NOR1dWCkFlQ0NqK1l1aUNKNUxkWCtqMlFib1lZRmgwY0xVSHJ4blgyejUzWS96bnoyaXRVR0ZWZnd4SjJPTWNFYUYzZWsKMUZFQWgwTmZuUml5dDcrTjlZanNvK2tNNEFFR0U4NlVhOG9KQ2d3UXFUTzFCc3IwSklRbGFNQzc3azVYTzJRZwo0Ni9mWjhqYjhxbGhoVEhNbmQxaEo3WG1PUk4renNFVlhzc1JyN2lFd1FLQmdRREdtcTJUbkNIUVN6VTdCUXl5CkJRNVdmUUx1RHc4QTVjQlI1aW5KOGpyd0FZWVZPa01QRnF5dTdzdGpmcm1uRnk3OUpMZHpPNWlDNmNCcGxjNzAKRE9OdjNqUnJLRGlueXdkNXNwQXVuRzh5NzRTNU9vWmRrazN4b3psalZ1dWdsY21jSitDNFovTWsrb2F6YTF2MgpvZ0p5cThQYjRMdTBESmN3V3dtOTdRdUt5UUtCZ1FDNW54RjF1Uk1wOHNOL1UxSnNIYUZLRjFNS2hLUEg2WkhkCm14QWV4OVlmNmRQTlB2YUt2ZEhEM24yTnFNaVF5bmdoV0hFR0RpVFBFK2tCam1KdkxPbTBqYmpUUmpQM1FZZTMKZ1pyem5xaGtyL0ZITkV6azlPQUdSQzUrOEl4VmtvcmVTcWE0STBGbUhVYWllRkdhdXpCUkc1N3M5MzQ5UVlkMwphSW9uNDZTRXNRS0JnSGZTa3E3Z0lEWi9hWm8yTGJhcC9rQ0lJK0JsRFhSSktZTkFEaTVkQ3RvSzBVNjFYQWdhCmNnMEkzWVVseS9UWHMrM2UzUitVOFNycXhML3ZObkZmNVVoMUU4TWkvU3VlL3QrWnNBdXZMaGZaRW9aK25OcVAKanA4ZkQxeXo4RzF1Y2JqWkJtZTdyNks3MDlFa0VOUDRZdW0wWC9LazRCcDlEaXFLZ3BJb0ZqS2hBb0dBVXBMQwpqNTRQT2wvMk85UHpISWxwMEszamtSQkVVNUJDQlZVUHJNRzFMV2sxZ1Y1N0NtazZ3V2xlYlFBaWlOYW83aHlMCjJ1ZTcxQ3JGUXAzMmlBSnd6Sk1uSDBWaHBLS1FIMEFXa0QyS0o1QmxRd212RTBNanpXWFRVVUR0REx3dDdvbEMKOVRNcHlxVkhZTXNwY2kzSFpxMWsyNEdWdE9aTHZ3RFFSTUp0MDJFQ2dZQWRwZVFpazdFa3pHMythNlZHenVwVQpQZUwrYnBLSEhVL2xFZ1ZBNnU2MkRkc3VmU0FiSWVrSHlHTjYvNlpzbUpITndFbzZVMFhRczRKYXBLdDJJMFFBCitUT1lYM1hnczlLcHE2TW90TjQ2Q241RWlUL1VoZXRNWkZyanpWaGVCYURlQ1BLY3R6WmpDeTJsbVcxMW1KcXQKUitwc2dhRzY0N3RRRmYvVklKMjFHZz09Ci0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0K" }, "client_certificate_b64": { "type": "string", "description": "Base64-encoded X.509 certificate for the client.\nIt works in conjunction with the client-key-data to authenticate the user to the Kubernetes API server.\nThis certificate is typically issued by a trusted Certificate Authority (CA).\n", "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURSekNDQWkrZ0F3SUJBZ0lCQVRBTkJna3Foa2lHOXcwQkFRc0ZBREJGTVFzd0NRWURWUVFHRXdKQlZURVQKTUJFR0ExVUVDQXdLVTI5dFpTMVRkR0YwWlRFaE1COEdBMVVFQ2d3WVNXNTBaWEp1WlhRZ1YybGtaMmwwY3lCUQpkSGtnVEhSa01CNFhEVEkxTURFeE9URTNNakF3TUZvWERUSTNNVEF4TmpFM01qQXdNRm93UlRFTE1Ba0dBMVVFCkJoTUNRVlV4RXpBUkJnTlZCQWdNQ2xOdmJXVXRVM1JoZEdVeElUQWZCZ05WQkFvTUdFbHVkR1Z5Ym1WMElGZHAKWkdkcGRITWdVSFI1SUV4MFpEQ0NBU0l3RFFZSktvWklodmNOQVFFQkJRQURnZ0VQQURDQ0FRb0NnZ0VCQUpBQgpMdzBVVHkvUSsrOUFZZ1FSMVAyMlNubmdTdGxvbDltOUdaRGtrM0lOc0RoVTdRVXJ4RG9iOFMwa3JqSDJhQ0hzCkNnTDZ5NVpwVUEwWmt4Y3dQc3dzR2FuR05ZcWs2alE2TmF2UFdxcnYyOFFpTjRNRnZLempLQVhtZ3FrZThtWVkKOU0zNk90VTdMTVR5UTNtdEJlV0dMdVBzTis1RXU5dEJBeUNMeTZYdDV0TThXM0lDYUF5Vnd5NXI4bkxaM2FYYgpuUDA4WjU3emIvV1QrdFZDb2pudjNWQmVhK0YyRWdLTW5Mb1BiemxKVnFKZTM1RTJFMCtkTERwdGsrOEJJajJaCkdUOFpVQnZUZzFYb1NDTUREemJmRXQ5MUl4WW1mMVdidjh3MjZ3TjRNUVBIdUNGSzlZUTZHWkNMQzNnVlZvM2IKNlo5ZFpoNVhMUTlBbnZ4T21Qa0NBd0VBQWFOQ01FQXdIUVlEVlIwT0JCWUVGUGhuc1I3S1VWbEVVSk1mSytXTwpZdUs4cXdwZ01COEdBMVVkSXdRWU1CYUFGT2F5RzJqTHFHU3VGbW04eU9hbURJNzdqNVM5TUEwR0NTcUdTSWIzCkRRRUJDd1VBQTRJQkFRQXcramdvNXZnOVZ4a1dnaDBiUDNtNlUzdnhwQkZkRlZpZTdBUjQreG5oM2lnS3RGYUYKeEZBS1AzUFlLNFJjV2g4cWV5S2NPeXZWOWN2VkZBYVFiUnFCTFhKK3hmQ0t5YWZmejZXWTJYNWx3Y3ZPdDBnVwpwMENTdmFib0JzWUYvZW5yQ2pJUHhUcmorMG5xZlB5djR6RmtOZkJSWCtZTlgrZVJqWHlESzM4N29EbGJOazlDCmJGV3Q1ZzVKZHpEclJjZ1dzbUZ5UnJycWkxekt4ZW9FVTR4TTh2Z3BLVk10dFRDQ0JLb01waVc4TmpBdDNKN1IKeTlYMDA3Snlld1pzampKaTVHc0FSVnFJTllyeVBBdm1sTzVKaWdZTzJtVU5IcmIvRW04RExjVkpWQzNPbThydQpSWEd6LzRSRTU5VVJDeHN3Z0dFeDhBd2s3b1l3enU0eXJXT1IKLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" }, "certificate_authority_b64": { "type": "string", "description": "Base64-encoded CA certificate used to verify the identity of the Kubernetes API server.\nIt ensures that the client is communicating with the legitimate Kubernetes API server by validating the server's certificate.\n", "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURhekNDQWxPZ0F3SUJBZ0lVZVFhNElNUGpWcGZraXlVd0YyTFBGcUlUcHJvd0RRWUpLb1pJaHZjTkFRRUwKQlFBd1JURUxNQWtHQTFVRUJoTUNRVlV4RXpBUkJnTlZCQWdNQ2xOdmJXVXRVM1JoZEdVeElUQWZCZ05WQkFvTQpHRWx1ZEdWeWJtVjBJRmRwWkdkcGRITWdVSFI1SUV4MFpEQWVGdzB5TlRBeE1Ua3hOekU1TkRkYUZ3MHlOekV3Ck1UWXhOekU1TkRkYU1FVXhDekFKQmdOVkJBWVRBa0ZWTVJNd0VRWURWUVFJREFwVGIyMWxMVk4wWVhSbE1TRXcKSHdZRFZRUUtEQmhKYm5SbGNtNWxkQ0JYYVdSbmFYUnpJRkIwZVNCTWRHUXdnZ0VpTUEwR0NTcUdTSWIzRFFFQgpBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRHNaWnliMTNpNTJWcktjZW1YUU5SUC8ycktUa0x2SzFvS0lqQkFLdWxwClUvdWJmdWw4VjhBMGZBdnh0L3N2dHRmTEEzRWNCNGdBeUNMK01kWEFFblQ5YjRsTzRDN3Q2dzVMM3ltWTN6WW0KMkE3Vjg3eDE3SU1yMXBWRXRieTZsWFJwcm8zSm5zVjJ0MDM0cDc2ckRYNTBZdjE4Mk1sSjA1aXRkSkVoMVRXWApwRkpXRk1DS3U5bnRGQ2w3TzZRMlR1TmpTd1ZSWDRCeVNHQ1JhTm5id0VBR1djaDVQK3pkQXRka2xGbUUyQXdUCklrR043aGVGTGs2aW5MUEptcDkvRFVKSGl4TnVlOXBlQkx1QXp1N2lsUWlzbjh1eWFITlFkMDZId0hyTkpTLysKaGxxUEVnckphTm5BWVpGMjFYamN3UWEzaGs2RW5rV2ZTc0R1b0gvYjNDWnhBZ01CQUFHalV6QlJNQjBHQTFVZApEZ1FXQkJRN2JLL2I3eVZpRG5hWCs4NXJ6Q1BicEpldWpEQWZCZ05WSFNNRUdEQVdnQlE3YksvYjd5VmlEbmFYCis4NXJ6Q1BicEpldWpEQVBCZ05WSFJNQkFmOEVCVEFEQVFIL01BMEdDU3FHU0liM0RRRUJDd1VBQTRJQkFRREsKRXN4eGpaTzEwM1Q4R3FhWGNBYXZPN2Q0cm8zSkthQy9uQVprLzc2SklxdUpxcC9ST2M2dnh4QW1venRFSGlBZgpYNS9CL1YxRnlGTVJydWpTbEd1bkxWQWJ4WHFSZ3BoSW9LK3R5N0VSeXB2NHdicUhpWUs3YnA4YUs5OUlsaGljCjJzclhpRURUTWozMWFkQk15NzFKdnd4d2RaT091MitFNEN0OGpRREJtQm1Jekh4dS9LT1pjNEVydE1kV3RlYjgKMCtFUXdwcWlHeDlxZ05tRk10T2hRWXpIMU9ETWp1Q2ZOTDZ5WnY3K2dRWHVEMlVQV0p0RjV3V29JanJTODRCTwpkVWhwbldodVhQVXRUTWNmWlMrbmZNZE5PY2pkOHRBa0tQNUowK0M4OTRuKzNMbUVNNndZdjJWYUI4MmVxNU1zCkhGZkZWSDVEN1dsWkdiMjNnUi9KCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" } }, "description": "Together, these elements ensure mutual TLS (mTLS) authentication between the Kubernetes client (kubectl) and the Kubernetes API server." } ] }, "ResourceUpdate": { "additionalProperties": "false", "type": "object", "properties": { "name": { "type": "string", "description": "A name for the resource.", "example": "naomis-resource" }, "description": { "type": "string", "description": "A description of the resource.", "example": "A good and detailed description that makes everyone understand." }, "tags": { "type": "array", "maxItems": "32", "description": "Custom tags for organizing and categorizing resources in the GUI.", "items": { "type": "string" }, "example": [ "tagA", "tagB", "tagC" ] } }, "description": "Defines a shared group of attributes to be found in all API resources." } } } } ````