rust.apidocumentation.com Open in urlscan Pro
34.132.239.214  Public Scan

URL: https://rust.apidocumentation.com/
Submission Tags: phishingrod
Submission: On January 14 via api from DE — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

Rust
Reference
Search ⌃k

 * Toggle group
   
   PET
   
   * Update an existing pet
     
     put
   
   * Add a new pet to the store
     
     post
   
   * Finds Pets by status
     
     get
   
   * Finds Pets by tags
     
     get
   
   * Find pet by ID
     
     get
   
   * Updates a pet in the store with form data
     
     post
   
   * Deletes a pet
     
     delete
   
   * uploads an image
     
     post
 * Toggle group
   
   STORE

 * Toggle group
   
   USER

 * Toggle group
   
   MODELS

Dark Mode

1.0.11
OAS 3.0.2


SWAGGER PETSTORE - OPENAPI 3.0

Download OpenAPI Spec

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You
can find out more about Swagger at http://swagger.io. In the third iteration of
the pet store, we've switched to the design first approach! You can now help us
improve the API whether it's by making changes to the definition itself or to
the code. That way, with time, we can improve the API in general, and expose
some of the new features in OAS3.

Some useful links:

 * The Pet Store repository
 * The source API definition for the Pet Store

Base URL

https://petstore3.swagger.io/api/v3

Client Libraries


Shell
Ruby
Ruby

Node.js

PHP

Python

C
Libcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

More
Shell cURL
Authentication
OAuth 2.0 OAuth 2.0API Key
Client ID
Scopes
0|2
Authorize


PET # COPY LINK TO "PET"

Everything about your Pets

Endpoints

put/petpost/petget/pet/findByStatusget/pet/findByTagsget/pet/{petId}post/pet/{petId}delete/pet/{petId}post/pet/{petId}/uploadImage


UPDATE AN EXISTING PET # COPY LINK TO "UPDATE AN EXISTING PET"

Update an existing pet by Id

Body
id
integer · int64
example: 10
Signed 64-bit integers (long type).
name
required
string
example: doggie
category

Show Child Attributes
photoUrls
required
array string[]
tags
array
Show Child Attributes
status
string · enum
pet status in the store
 * available
 * pending
 * sold

Responses
 * 200
   
   Successful operation

 * 400
   
   Invalid ID supplied

 * 404
   
   Pet not found

 * 405
   
   Validation exception

put/pet
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
99
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request PUT \
--url https://petstore3.swagger.io/api/v3/pet \
--header 'Content-Type: application/json' \
--data '{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
""
],
"tags": [
{
"id": 1,
"name": ""
}
],
"status": "available"
}'
Test Request
200400404405

{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"…"
],
"tags": [
{
"id": 1,
"name": "…"
}
],
"status": "available"
}

Successful operation


ADD A NEW PET TO THE STORE # COPY LINK TO "ADD A NEW PET TO THE STORE"

Add a new pet to the store

Body
id
integer · int64
example: 10
Signed 64-bit integers (long type).
name
required
string
example: doggie
category

Show Child Attributes
photoUrls
required
array string[]
tags
array
Show Child Attributes
status
string · enum
pet status in the store
 * available
 * pending
 * sold

Responses
 * 200
   
   Successful operation

 * 405
   
   Invalid input

post/pet
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
99
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request POST \
--url https://petstore3.swagger.io/api/v3/pet \
--header 'Content-Type: application/json' \
--data '{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
""
],
"tags": [
{
"id": 1,
"name": ""
}
],
"status": "available"
}'
Test Request
200405

{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"…"
],
"tags": [
{
"id": 1,
"name": "…"
}
],
"status": "available"
}

Successful operation


FINDS PETS BY STATUS # COPY LINK TO "FINDS PETS BY STATUS"

Multiple status values can be provided with comma separated strings

Query Parameters
 * statusstring
   
   Status values that need to be considered for filter
   
   Show Child Attributes

Responses
 * 200
   
   successful operation

 * 400
   
   Invalid status value

get/pet/findByStatus
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request GET \
--url https://petstore3.swagger.io/api/v3/pet/findByStatus
Test Request
200400

[
{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"…"
],
"tags": [
{
"id": 1,
"name": "…"
}
],
"status": "available"
}
]

successful operation


FINDS PETS BY TAGS # COPY LINK TO "FINDS PETS BY TAGS"

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3
for testing.

Query Parameters
 * tagsarray
   
   Tags to filter by
   
   Show Child Attributes

Responses
 * 200
   
   successful operation

 * 400
   
   Invalid tag value

get/pet/findByTags
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request GET \
--url https://petstore3.swagger.io/api/v3/pet/findByTags
Test Request
200400

[
{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"…"
],
"tags": [
{
"id": 1,
"name": "…"
}
],
"status": "available"
}
]

successful operation


FIND PET BY ID # COPY LINK TO "FIND PET BY ID"

Returns a single pet

Path Parameters
 * petId required integer
   
   ID of pet to return
   
   Show Child Attributes

Responses
 * 200
   
   successful operation

 * 400
   
   Invalid ID supplied

 * 404
   
   Pet not found

get/pet/{petId}
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request GET \
--url https://petstore3.swagger.io/api/v3/pet/__PETID__
Test Request
200400404

{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"…"
],
"tags": [
{
"id": 1,
"name": "…"
}
],
"status": "available"
}

successful operation


UPDATES A PET IN THE STORE WITH FORM DATA # COPY LINK TO "UPDATES A PET IN THE
STORE WITH FORM DATA"

Path Parameters
 * petId required integer
   
   ID of pet that needs to be updated
   
   Show Child Attributes

Query Parameters
 * namestring
   
   Name of pet that needs to be updated
   
   Show Child Attributes
 * statusstring
   
   Status of pet that needs to be updated
   
   Show Child Attributes

Responses
 * 405
   
   Invalid input

post/pet/{petId}
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request POST \
--url https://petstore3.swagger.io/api/v3/pet/__PETID__
Test Request
405

No Body

Invalid input


DELETES A PET # COPY LINK TO "DELETES A PET"

Path Parameters
 * petId required integer
   
   Pet id to delete
   
   Show Child Attributes

Headers
 * api_keystring
   Show Child Attributes

Responses
 * 400
   
   Invalid pet value

delete/pet/{petId}
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
curl --request DELETE \
--url https://petstore3.swagger.io/api/v3/pet/__PETID__
Test Request
400

No Body

Invalid pet value


UPLOADS AN IMAGE # COPY LINK TO "UPLOADS AN IMAGE"

Path Parameters
 * petId required integer
   
   ID of pet to update
   
   Show Child Attributes

Query Parameters
 * additionalMetadatastring
   
   Additional Metadata
   
   Show Child Attributes

Responses
 * 200
   
   successful operation

post/pet/{petId}/uploadImage
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpXMLHttpRequestAxiosjQueryOkHttpundiciHTTPRequestAxiosNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession
9
1
2
3
4
curl --request POST \
--url https://petstore3.swagger.io/api/v3/pet/__PETID__/uploadImage \
--header 'Content-Type: application/octet-stream' \
--data BINARY
Test Request
200

{
"code": 1,
"type": "…",
"message": "…"
}

successful operation


STORE # COPY LINK TO "STORE"

Access to Petstore orders

Endpoints

get/store/inventorypost/store/orderget/store/order/{orderId}delete/store/order/{orderId}
Show More


USER # COPY LINK TO "USER"

Operations about user

Endpoints

post/userpost/user/createWithListget/user/loginget/user/logoutget/user/{username}put/user/{username}delete/user/{username}
Show More


ORDER # COPY LINK TO "ORDER"

{} <order />
id
integer · int64
example: 10
Signed 64-bit integers (long type).
petId
integer · int64
example: 198772
Signed 64-bit integers (long type).
quantity
integer · int32
example: 7
Signed 32-bit integers (commonly used integer type).
shipDate
string · date-time
the date-time notation as defined by RFC 3339, section 5.6, for example,
2017-07-21T17:32:28Z
status
string · enum
example: approved
Order Status
 * placed
 * approved
 * delivered

complete
boolean


CUSTOMER # COPY LINK TO "CUSTOMER"

{} <customer />
id
integer · int64
example: 100000
Signed 64-bit integers (long type).
username
string
example: fehguy
address
array
{} <address />
street
string
example: 437 Lytton
city
string
example: Palo Alto
state
string
example: CA
zip
string
example: 94301


ADDRESS # COPY LINK TO "ADDRESS"

{} <address />
street
string
example: 437 Lytton
city
string
example: Palo Alto
state
string
example: CA
zip
string
example: 94301
Show More

This documentation playground was created by Scalar. For help, questions or
feedback don't hesitate to email our support.


You can fully customize or delete this footer by simply navigating to the footer
section of the "customize" button within our header.


Features About Pricing
Privacy Policy Terms of Service Pricing


© 2023 Scalar