This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.
An API key is a special token (api_key) that you need to provide in header when making API calls, Like:
{ api_key: "TOKEN_VALUE" }
OAuth is an open standard for access delegation, commonly used as a way for Internet users to grant websites or applications access to their information on other websites but without giving them the passwords
Oauth Server Details
| Authorization URL | https://petstore.swagger.io/oauth/authorize | |
| Token URL | ||
| Flow | implicit |
Scopes
| read:pets | read your pets | |
| write:pets | modify pets in your account |
post https://petstore.swagger.io/v2 /pet/{petId}/uploadImage Try Out
path
integer
ID of pet to update
formData
string
Additional data to pass to server
file
file to upload
successful operation
Example Value | Model
{
"code": "",
"type": "",
"message": ""
}curl --request POST \
--url https://petstore.swagger.io/v2/pet/{petId}/uploadImage \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'additionalMetadata=Something' \
--form 'file=@FILE'fetch('https://petstore.swagger.io/v2/pet/{petId}/uploadImage', {
method: 'POST',
headers: {
"Content-Type": "application/x-www-form-urlencoded"
},
body: 'additionalMetadata=Something&file=@FILE',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/pet/{petId}/uploadImage',
qs: {"additionalMetadata": "Something","file": "@FILE"},
headers: {"Content-Type": "application/x-www-form-urlencoded"},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet/{petId}/uploadImage"
headers = {
"Content-Type": "application/x-www-form-urlencoded"
}
body = {
"additionalMetadata": "Something",
"file": "@FILE"
}
response = requests.POST(url, headers=headers)post https://petstore.swagger.io/v2 /pet Try Out
body
Pet object that needs to be added to the store
Example Value | Model
{
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
}Invalid input
Example Value | Model
""curl --request POST \
--url https://petstore.swagger.io/v2/pet \
--body '{"id":"","category":{"id":"","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"","name":""}],"status":""}'fetch('https://petstore.swagger.io/v2/pet', {
method: 'POST',
body: {
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
},
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/pet',
body: {
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet"
headers = {
}
body = {
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
}
response = requests.POST(url, headers=headers, body=body)put https://petstore.swagger.io/v2 /pet Try Out
body
Pet object that needs to be added to the store
Example Value | Model
{
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
}Invalid ID supplied
Example Value | Model
""Pet not found
Example Value | Model
""Validation exception
Example Value | Model
""curl --request PUT \
--url https://petstore.swagger.io/v2/pet \
--body '{"id":"","category":{"id":"","name":""},"name":"doggie","photoUrls":[""],"tags":[{"id":"","name":""}],"status":""}'fetch('https://petstore.swagger.io/v2/pet', {
method: 'PUT',
body: {
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
},
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'PUT',
url: 'https://petstore.swagger.io/v2/pet',
body: {
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet"
headers = {
}
body = {
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
}
response = requests.PUT(url, headers=headers, body=body)Multiple status values can be provided with comma separated strings
get https://petstore.swagger.io/v2 /pet/findByStatus Try Out
query
array
Possible Value: available, pending, soldStatus values that need to be considered for filter
successful operation
Example Value | Model
""Invalid status value
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/pet/findByStatus?status=fetch('https://petstore.swagger.io/v2/pet/findByStatus?status=', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/pet/findByStatus?status=',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet/findByStatus?status="
headers = {
}
response = requests.GET(url, headers=headers)Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
get https://petstore.swagger.io/v2 /pet/findByTags Try Out
query
array
Tags to filter by
successful operation
Example Value | Model
""Invalid tag value
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/pet/findByTags?tags=fetch('https://petstore.swagger.io/v2/pet/findByTags?tags=', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/pet/findByTags?tags=',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet/findByTags?tags="
headers = {
}
response = requests.GET(url, headers=headers)Returns a single pet
get https://petstore.swagger.io/v2 /pet/{petId} Try Out
path
integer
ID of pet to return
successful operation
Example Value | Model
{
"id": "",
"category": {
"id": "",
"name": ""
},
"name": "doggie",
"photoUrls": [
""
],
"tags": [
{
"id": "",
"name": ""
}
],
"status": ""
}Invalid ID supplied
Example Value | Model
""Pet not found
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/pet/{petId}fetch('https://petstore.swagger.io/v2/pet/{petId}', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/pet/{petId}',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet/{petId}"
headers = {
}
response = requests.GET(url, headers=headers)post https://petstore.swagger.io/v2 /pet/{petId} Try Out
path
integer
ID of pet that needs to be updated
formData
string
Updated name of the pet
string
Updated status of the pet
Invalid input
Example Value | Model
""curl --request POST \
--url https://petstore.swagger.io/v2/pet/{petId} \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'name=Something' \
--form 'status=Something'fetch('https://petstore.swagger.io/v2/pet/{petId}', {
method: 'POST',
headers: {
"Content-Type": "application/x-www-form-urlencoded"
},
body: 'name=Something&status=Something',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/pet/{petId}',
qs: {"name": "Something","status": "Something"},
headers: {"Content-Type": "application/x-www-form-urlencoded"},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet/{petId}"
headers = {
"Content-Type": "application/x-www-form-urlencoded"
}
body = {
"name": "Something",
"status": "Something"
}
response = requests.POST(url, headers=headers)delete https://petstore.swagger.io/v2 /pet/{petId} Try Out
header
string
path
integer
Pet id to delete
Invalid ID supplied
Example Value | Model
""Pet not found
Example Value | Model
""curl --request DELETE \
--url https://petstore.swagger.io/v2/pet/{petId} \
--header 'api_key: Something'fetch('https://petstore.swagger.io/v2/pet/{petId}', {
method: 'DELETE',
headers: {
"api_key": "Something"
},
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'DELETE',
url: 'https://petstore.swagger.io/v2/pet/{petId}',
headers: {"api_key": "Something"},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/pet/{petId}"
headers = {
"api_key": "Something"
}
response = requests.DELETE(url, headers=headers)post https://petstore.swagger.io/v2 /store/order Try Out
body
order placed for purchasing the pet
Example Value | Model
{
"id": "",
"petId": "",
"quantity": "",
"shipDate": "",
"status": "",
"complete": ""
}successful operation
Example Value | Model
{
"id": "",
"petId": "",
"quantity": "",
"shipDate": "",
"status": "",
"complete": ""
}Invalid Order
Example Value | Model
""curl --request POST \
--url https://petstore.swagger.io/v2/store/order \
--body '{"id":"","petId":"","quantity":"","shipDate":"","status":"","complete":""}'fetch('https://petstore.swagger.io/v2/store/order', {
method: 'POST',
body: {
"id": "",
"petId": "",
"quantity": "",
"shipDate": "",
"status": "",
"complete": ""
},
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/store/order',
body: {
"id": "",
"petId": "",
"quantity": "",
"shipDate": "",
"status": "",
"complete": ""
},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/store/order"
headers = {
}
body = {
"id": "",
"petId": "",
"quantity": "",
"shipDate": "",
"status": "",
"complete": ""
}
response = requests.POST(url, headers=headers, body=body)For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions
get https://petstore.swagger.io/v2 /store/order/{orderId} Try Out
path
integer
ID of pet that needs to be fetched
successful operation
Example Value | Model
{
"id": "",
"petId": "",
"quantity": "",
"shipDate": "",
"status": "",
"complete": ""
}Invalid ID supplied
Example Value | Model
""Order not found
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/store/order/{orderId}fetch('https://petstore.swagger.io/v2/store/order/{orderId}', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/store/order/{orderId}',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/store/order/{orderId}"
headers = {
}
response = requests.GET(url, headers=headers)For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors
delete https://petstore.swagger.io/v2 /store/order/{orderId} Try Out
path
integer
ID of the order that needs to be deleted
Invalid ID supplied
Example Value | Model
""Order not found
Example Value | Model
""curl --request DELETE \
--url https://petstore.swagger.io/v2/store/order/{orderId}fetch('https://petstore.swagger.io/v2/store/order/{orderId}', {
method: 'DELETE',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'DELETE',
url: 'https://petstore.swagger.io/v2/store/order/{orderId}',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/store/order/{orderId}"
headers = {
}
response = requests.DELETE(url, headers=headers)Returns a map of status codes to quantities
get https://petstore.swagger.io/v2 /store/inventory Try Out
successful operation
Example Value | Model
{}curl --request GET \
--url https://petstore.swagger.io/v2/store/inventoryfetch('https://petstore.swagger.io/v2/store/inventory', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/store/inventory',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/store/inventory"
headers = {
}
response = requests.GET(url, headers=headers)post https://petstore.swagger.io/v2 /user/createWithArray Try Out
body
List of user object
Example Value | Model
""successful operation
Example Value | Model
""curl --request POST \
--url https://petstore.swagger.io/v2/user/createWithArray \
--body '""'fetch('https://petstore.swagger.io/v2/user/createWithArray', {
method: 'POST',
body: "",
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/user/createWithArray',
body: "",
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/createWithArray"
headers = {
}
body = ""
response = requests.POST(url, headers=headers, body=body)post https://petstore.swagger.io/v2 /user/createWithList Try Out
body
List of user object
Example Value | Model
""successful operation
Example Value | Model
""curl --request POST \
--url https://petstore.swagger.io/v2/user/createWithList \
--body '""'fetch('https://petstore.swagger.io/v2/user/createWithList', {
method: 'POST',
body: "",
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/user/createWithList',
body: "",
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/createWithList"
headers = {
}
body = ""
response = requests.POST(url, headers=headers, body=body)get https://petstore.swagger.io/v2 /user/{username} Try Out
path
string
The name that needs to be fetched. Use user1 for testing.
successful operation
Example Value | Model
{
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
}Invalid username supplied
Example Value | Model
""User not found
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/user/{username}fetch('https://petstore.swagger.io/v2/user/{username}', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/user/{username}',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/{username}"
headers = {
}
response = requests.GET(url, headers=headers)This can only be done by the logged in user.
put https://petstore.swagger.io/v2 /user/{username} Try Out
path
string
name that need to be updated
body
Updated user object
Example Value | Model
{
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
}Invalid user supplied
Example Value | Model
""User not found
Example Value | Model
""curl --request PUT \
--url https://petstore.swagger.io/v2/user/{username} \
--body '{"id":"","username":"","firstName":"","lastName":"","email":"","password":"","phone":"","userStatus":""}'fetch('https://petstore.swagger.io/v2/user/{username}', {
method: 'PUT',
body: {
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
},
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'PUT',
url: 'https://petstore.swagger.io/v2/user/{username}',
body: {
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/{username}"
headers = {
}
body = {
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
}
response = requests.PUT(url, headers=headers, body=body)This can only be done by the logged in user.
delete https://petstore.swagger.io/v2 /user/{username} Try Out
path
string
The name that needs to be deleted
Invalid username supplied
Example Value | Model
""User not found
Example Value | Model
""curl --request DELETE \
--url https://petstore.swagger.io/v2/user/{username}fetch('https://petstore.swagger.io/v2/user/{username}', {
method: 'DELETE',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'DELETE',
url: 'https://petstore.swagger.io/v2/user/{username}',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/{username}"
headers = {
}
response = requests.DELETE(url, headers=headers)get https://petstore.swagger.io/v2 /user/login Try Out
query
string
The user name for login
string
The password for login in clear text
successful operation
Example Value | Model
""Headers
date in UTC when token expires
calls per hour allowed by the user
Invalid username/password supplied
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/user/login?username=Something&password=Somethingfetch('https://petstore.swagger.io/v2/user/login?username=Something&password=Something', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/user/login?username=Something&password=Something',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/login?username=Something&password=Something"
headers = {
}
response = requests.GET(url, headers=headers)get https://petstore.swagger.io/v2 /user/logout Try Out
successful operation
Example Value | Model
""curl --request GET \
--url https://petstore.swagger.io/v2/user/logoutfetch('https://petstore.swagger.io/v2/user/logout', {
method: 'GET',
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'GET',
url: 'https://petstore.swagger.io/v2/user/logout',
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user/logout"
headers = {
}
response = requests.GET(url, headers=headers)This can only be done by the logged in user.
post https://petstore.swagger.io/v2 /user Try Out
body
Created user object
Example Value | Model
{
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
}successful operation
Example Value | Model
""curl --request POST \
--url https://petstore.swagger.io/v2/user \
--body '{"id":"","username":"","firstName":"","lastName":"","email":"","password":"","phone":"","userStatus":""}'fetch('https://petstore.swagger.io/v2/user', {
method: 'POST',
body: {
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
},
})
.then(e => e.json())
.then((data) => {
console.log('Request succeeded with JSON response', data);
})
.catch((error) => {
console.log('Request failed', error);
});const request = require('request');
const options = {
method: 'POST',
url: 'https://petstore.swagger.io/v2/user',
body: {
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
},
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});import requests
url = "https://petstore.swagger.io/v2/user"
headers = {
}
body = {
"id": "",
"username": "",
"firstName": "",
"lastName": "",
"email": "",
"password": "",
"phone": "",
"userStatus": ""
}
response = requests.POST(url, headers=headers, body=body)