Skip to content

Commit 516e94d

Browse files
Add POST, GET, and DELETE Object Storage SSL Cert
1 parent 9c74ea1 commit 516e94d

File tree

1 file changed

+159
-0
lines changed

1 file changed

+159
-0
lines changed

openapi.yaml

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11717,6 +11717,134 @@ paths:
1171711717
- lang: CLI
1171811718
source: >
1171911719
linode-cli object-storage cancel
11720+
/object-storage/buckets/{clusterId}/{bucket}/ssl:
11721+
x-linode-cli-command: object-storage
11722+
parameters:
11723+
- name: clusterId
11724+
in: path
11725+
description: The ID of the cluster this bucket exists in.
11726+
required: true
11727+
schema:
11728+
type: string
11729+
- name: bucket
11730+
in: path
11731+
description: The bucket name.
11732+
required: true
11733+
schema:
11734+
type: string
11735+
get:
11736+
operationId: getObjectStorageSSL
11737+
x-linode-cli-action: ssl-view
11738+
servers:
11739+
- url: https://api.linode.com/v4
11740+
summary: View Object Storage SSL Cert
11741+
description: |
11742+
Returns whether this bucket has a corresponding SSL certificate that was
11743+
uploaded by a user.
11744+
tags:
11745+
- Object Storage
11746+
security:
11747+
- personalAccessToken: []
11748+
- oauth:
11749+
- object_storage:read_only
11750+
responses:
11751+
'200':
11752+
description: >
11753+
Returns whether this bucket has a corresponding SSL certificate
11754+
that was uploaded by a user.
11755+
content:
11756+
application/json:
11757+
schema:
11758+
$ref: '#/components/schemas/ObjectStorageSSLResponse'
11759+
default:
11760+
$ref: '#/components/responses/ErrorResponse'
11761+
x-code-samples:
11762+
- lang: Shell
11763+
source: >
11764+
curl -H "Authorization: Bearer $TOKEN" \
11765+
https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl
11766+
- lang: CLI
11767+
source: >
11768+
linode-cli object-storage ssl-view \
11769+
us-east-1 example-bucket
11770+
post:
11771+
operationId: createObjectStorageSSL
11772+
x-linode-cli-action: ssl-upload
11773+
servers:
11774+
- url: https://api.linode.com/v4
11775+
summary: Upload Object Storage SSL Cert
11776+
description: |
11777+
Upload an SSL certificate to be served when you visit your Object Storage bucket via HTTPS.
11778+
Your SSL certificate and private key are stored encrypted at rest.
11779+
tags:
11780+
- Object Storage
11781+
security:
11782+
- personalAccessToken: []
11783+
- oauth:
11784+
- object_storage:read_write
11785+
requestBody:
11786+
description: Upload this SSL certificate with its corresponding secret key.
11787+
content:
11788+
application/json:
11789+
schema:
11790+
$ref: '#/components/schemas/ObjectStorageSSL'
11791+
responses:
11792+
'200':
11793+
description: Returns whether this bucket has a corresponding SSL certificate that was uploaded by a user.
11794+
content:
11795+
application/json:
11796+
schema:
11797+
$ref: '#/components/schemas/ObjectStorageSSLResponse'
11798+
$ref: '#/components/responses/ErrorResponse'
11799+
x-code-samples:
11800+
- lang: Shell
11801+
source: >
11802+
curl -H "Content-Type: application/json" \
11803+
-H "Authorization: Bearer $TOKEN" \
11804+
-X POST -d ‘{
11805+
"certificate": "-----BEGIN CERTIFICATE-----MIIDbDCCAlQCCQCl-----END CERTIFICATE-----",
11806+
"private_key": "RwtqMlXveYH531g770BBNluAk9s"
11807+
}’ \
11808+
https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl
11809+
- lang: CLI
11810+
source: >
11811+
linode-cli object-storage ssl-upload \
11812+
us-east-1 example-bucket \
11813+
--certificate "-----BEGIN CERTIFICATE-----MIIDbDCCAlQCCQCl-----END CERTIFICATE-----" \
11814+
--private_key "RwtqMlXveYH531g770BBNluAk9s"
11815+
delete:
11816+
operationId: getObjectStorageSSL
11817+
x-linode-cli-action: ssl-delete
11818+
servers:
11819+
- url: https://api.linode.com/v4
11820+
summary: Delete Object Storage SSL Cert
11821+
description: |
11822+
Deletes this Object Storage buckets user uploaded SSL certificate.
11823+
tags:
11824+
- Object Storage
11825+
security:
11826+
- personalAccessToken: []
11827+
- oauth:
11828+
- object_storage:read_write
11829+
responses:
11830+
'200':
11831+
description: Deletes this Object Storage bucket's user uploaded SSL certificate and private key.
11832+
content:
11833+
application/json:
11834+
schema:
11835+
type: object
11836+
default:
11837+
$ref: '#/components/responses/ErrorResponse'
11838+
x-code-samples:
11839+
- lang: Shell
11840+
source: >
11841+
curl -H "Authorization: Bearer $TOKEN" \
11842+
-X DELETE \
11843+
https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl
11844+
- lang: CLI
11845+
source: >
11846+
linode-cli object-storage ssl-delete \
11847+
us-east-1 example-bucket
1172011848
/profile:
1172111849
x-linode-cli-command: profile
1172211850
get:
@@ -18838,6 +18966,37 @@ components:
1883818966
- read_only
1883918967
description: This Limited Access Key's permissions for the selected bucket.
1884018968
example: read_only
18969+
ObjectStorageSSL:
18970+
type: object
18971+
description: >
18972+
An Object in Object Storage, or a "prefix" that contains one
18973+
or more objects when a `delimiter` is used.
18974+
properties:
18975+
certificate:
18976+
type: string
18977+
description: >
18978+
Your Base64 encoded and PEM formatted SSL certificate.
18979+
example: >
18980+
"-----BEGIN CERTIFICATE-----
18981+
MIIFTTCCAzWgAwIBAgIURwtqMlXveYH531g770BBNluAk9swDQYJKoZIhvcNAQEL
18982+
D79A2svTqSsN+bDIVWoUd14=
18983+
-----END CERTIFICATE-----"
18984+
private_key:
18985+
type: string
18986+
description: >
18987+
The private key associated with this SSL certificate.
18988+
example: RwtqMlXveYH531g770BBNluAk9s
18989+
ObjectStorageSSLResponse:
18990+
type: object
18991+
description: >
18992+
If this Object Storage bucket has a corresponding SSL Certificate.
18993+
properties:
18994+
ssl:
18995+
type: boolean
18996+
description: >
18997+
If this Bucket has a corresponding SSL certificate that was uploaded by a user.
18998+
example: true
18999+
readOnly: true
1884119000
PaginationEnvelope:
1884219001
type: object
1884319002
description: >

0 commit comments

Comments
 (0)