|
| 1 | +/* |
| 2 | + * Licensed to Elasticsearch B.V. under one or more contributor |
| 3 | + * license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright |
| 5 | + * ownership. Elasticsearch B.V. licenses this file to you under |
| 6 | + * the Apache License, Version 2.0 (the "License"); you may |
| 7 | + * not use this file except in compliance with the License. |
| 8 | + * You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | + |
| 20 | +import { RequestBase } from '@_types/Base' |
| 21 | +import { Id, Metadata } from '@_types/common' |
| 22 | +import { Duration } from '@_types/Time' |
| 23 | + |
| 24 | +/** |
| 25 | + * Update cross-cluster API key. |
| 26 | + * |
| 27 | + * Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. |
| 28 | + * @rest_spec_name security.update_cross_cluster_api_key |
| 29 | + * @availability stack stability=stable |
| 30 | + * @ext_doc_id remote-clusters-api-key |
| 31 | + */ |
| 32 | +export interface Request extends RequestBase { |
| 33 | + path_parts: { |
| 34 | + /** |
| 35 | + * The ID of the cross-cluster API key to update. |
| 36 | + */ |
| 37 | + id: Id |
| 38 | + } |
| 39 | + body: { |
| 40 | + /** |
| 41 | + * Expiration time for the API key. |
| 42 | + * By default, API keys never expire. This property can be omitted to leave the value unchanged. |
| 43 | + */ |
| 44 | + expiration?: Duration |
| 45 | + /** |
| 46 | + * Arbitrary metadata that you want to associate with the API key. |
| 47 | + * It supports nested data structure. |
| 48 | + * Within the metadata object, keys beginning with `_` are reserved for system usage. |
| 49 | + * When specified, this information fully replaces metadata previously associated with the API key. |
| 50 | + */ |
| 51 | + metadata?: Metadata |
| 52 | + } |
| 53 | +} |
0 commit comments