ProfitBricks API Documentation V1 · ProfitBricks API Documentation v1.2 4 / 72 Update Load...
Transcript of ProfitBricks API Documentation V1 · ProfitBricks API Documentation v1.2 4 / 72 Update Load...
ProfitBricks API Documentation v1.2
1 / 72
ProfitBricks API Documentation V1.2
ProfitBricks API Documentation v1.2
2 / 72
Table of contents
!"#$%&'(&)'*!%*!+&
Table of contents !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "
Overview !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #
How to Access the API !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #
Version History !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! $
Fundamentals !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! %
Resource Limits !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &&
API Outline !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &"
Authentication !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &"
SOAP Request!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &"
SOAP Response !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &"
SOAP Fault & Error Codes!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &'
API Methods!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &#
User Notifications !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &#
Get Notifications !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &#
Delete Notifications!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &$
Virtual Data Center Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &%
Create Data Center !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &%
Get Data Center by ID!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! &(
Get Data Center State !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ")
Get All Data Centers !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "&
Update Data Center !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "&
Clear Data Center!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ""
Delete Data Center !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ""
Server Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "'
ProfitBricks API Documentation v1.2
3 / 72
Create Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "'
Get Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "*
Get All Servers !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "$
Update Server!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! "(
Delete Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ')
Reset Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ')
Start Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '&
Stop Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '&
Storage Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '"
Create Storage!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '"
Get Storage !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '+
Get All Storages!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '*
Connect Storage!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '*
Disconnect Storage !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '#
Update Storage !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '#
Delete Storage!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '$
Snapshot Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '$
Create Snapshot !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '%
Get Snapshot !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '(
Get All Snapshots !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +)
Update Snapshot!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +)
Delete Snapshot !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +&
Rollback Snapshot!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +"
Load Balancer Operations!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +"
Create Load Balancer !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +'
Get Load Balancer!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ++
Get All Load Balancer !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +*
ProfitBricks API Documentation v1.2
4 / 72
Update Load Balancer !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +$
Register Servers On Load Balancer !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +$
Deregister Servers On Load Balancer !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +%
Delete Load Balancer!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +(
Activate/Deactivate Load Balancing On Servers !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +(
Firewall Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *)
Add Firewall Rules!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *&
Get Firewall !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *'
Get All Firewalls !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *'
Remove Firewall Rules !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *+
Activate/Deactivate Firewall !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! **
Delete Firewall !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! **
CD-ROM/DVD Drive Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *#
Add CD-ROM/DVD Drive To Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *#
Remove CD-ROM/DVD Drive From Server !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *$
Image Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *$
Set Image OS Type!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *%
Get Image !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *%
Get All Images !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! *(
Update Image!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #)
Delete Image !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #&
NIC Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #"
Create NIC!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #"
Get NIC !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #'
Get All NIC !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #+
Set Internet Access!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #*
Update NIC !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #*
ProfitBricks API Documentation v1.2
5 / 72
Delete NIC!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! ##
Public IP Operations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #$
Reserve Public IP Block !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #$
Add Public IP To NIC !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #%
Get Public IP Block!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #(
Get All Public IP Blocks!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #(
Remove Public IP From Nic !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! $)
Release Public IP Block !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! $)
Legal Notice !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! $"
ProfitBricks API Documentation v1.2
6 / 72
Overview
',%-,.%/&!
"#$%&'(#&)*+!$%%,#+!-#$%,++&$./0!1//2!+$03'&$.+!'4/'!)/.!5,!/3'$6/'&)/007!6/./8,9!'4#$384!$3#!
5#$:+,#;5/+,9!<=/'/),.',#!=,+&8.,#>!?=@=A!'$$0!/+!:,00!/+!/!'4#$384!/!+,)3#,!/.9!,/+7!'$!
3+,!2BC"!5/+,9!C"1D!!
"#$%&'(#&)*+!C"1!/00$:+!'4,!)3+'$6,#!'$!9,E,0$-!/--0&)/'&$.+!%$#!/3'$6/'&.8!'4,!6/./8,6,.'!
$%!'4,&#!E&#'3/0!#,+$3#),+D!!
F4,!C"1!&+!9,+&8.,9!'$!0,'!'4,!,.9!3+,#!0,E,#/8,!'4,!+/6,!-$:,#!/.9!%0,G&5&0&'7!$%%,#,9!57!$3#!
=/'/!@,.',#!=,+&8.,#!?=@=A!E&+3/0!'$$0!:4&0,!/'!'4,!+/6,!'&6,!'/*&.8!/9E/.'/8,!$%!'4,!
)$6-0,',!/3'$6/'&$.!$%!)0$39!)$6-3'&.8!,.E&#$.6,.'+D!!
C+!5$'4!'$$0+!6/*,!3+,!$%!'4,!+/6,!)$.),-'+!-,#'/&.&.8!'$!$3#!-$:,#%30!E&#'3/0!9/'/),.',#!
6$9,0H!'4,!C"1!0,/#.&.8!,G-,#&,.),!+'/7+!/+!+6$$'4!/.9!&.'3&'&E,!/+!-$++&50,D!
F4#$384!'4,!3+,!$%!+3)4!&.',#%/),H!&.!)$.I3.)'&$.!:&'4!6$.&'$#&.8!+$03'&$.+!'4/'!'4,!)3+'$6,#!
)/.!9,-0$7!$.!'4,&#!E&#'3/0!&.%#/+'#3)'3#,H!%300!4$#&J$.'/0!/.9!E,#'&)/0!+)/0/5&0&'7!/#,!,/+&,#!'$!
/)4&,E,D!F4&+!,./50,+!'4,!)3+'$6,#!'$!$-'&6&J,!4&+!&.%#/+'#3)'3#,!/.9!&'+!#,0/',9!)$+'+D!
F4&+!9$)36,.'!9,+)#&5,+!#,0,/+,!KDL!$%!"#$%&'(#&)*+!C"1D!1'+!$5I,)'&E,!&+!'$!8&E,!9,E,0$-,#+!/!
)$6-0,',!$E,#E&,:!$%!&'+!%3.)'&$./0&'7!/.9!-#$E&9,!/!E/0&9!#,%,#,.),!93#&.8!'4,!9,E,0$-6,.'!
-#$),++D!!
How to Access the API
0'/&!'&"))%++&!0%&"1.&!
234&567&655899&:;8&"1.&;8<8=&
/8>&+8<?@58&%7AB3@7:=&
4''-+MNN/-&D-#$%&'5#&)*+D)$6NKDL!
/+C$&$356:@37=&
4''-+MNN/-&D-#$%&'5#&)*+D)$6NKDLN:+90
ProfitBricks API Documentation v1.2
7 / 72
Version History
,%-+.'*&0.+!'-2&!
F4,!%$00$:&.8!0&+'!8&E,+!/.!$E,#E&,:!/5$3'!#,),.'!3-9/',+!+$!'4/'!7$3!8,'!/!+366/#7!:4&)4!
)4/.8,+!/--0&,9!'$!'4,!0/+'!3-9/',D!
Date of Change Affected Method Description
LOKP;KO;KO! +,E,#/0!.,:!)$66/.9+!
&.)039,9!'4,#,!/#,!+,E,#/0!.,:!)$66/.9+!/E/&0/50,M!
;!getAllServers!
;!getAllStorages!
;!getAllNic!
;!getAllFirewalls!
;!getAllLoadBalancer!
;!getPublicIpBlock!
;!updateImage!
;!deleteImage!
LOKP;OQ;LR! 2./-+4$'!B-,#/'&$.+! F4,#,!&+!/!.,:!)/00!'$!#,S3,+'!/!-/#'&)30/#!+./-+4$'!&.+',/9!$%!
#,),&E&.8!/!)$6-0,',!0&+'T!/0+$H!':$!.,:!/''#&53',!8$'!/99,9!
U.&)V$'"038U!/+!:,00!/+!U.&)V$'W."038U!
LOKP;OQ;LR! createStorage! 1%!U5$$'X#$62'$#/8,19U!&+!3+,9!'4,!+'$#/8,!)$..,)'&$.!:&00!5,!
$%!'7-,!Y1ZF1BD!(,%$#,!3-9/',!&'!:/+!1=[!-,#!9,%/30'D!
LOKP;OR;KR! 2./-+4$'!B-,#/'&$.+! 1'!&+!-$++&50,!'$!)#,/',!+./-+4$'+!%#$6!+'$#/8,!/.9!/--07!
'4,+,!+./-+4$'+!'$!$'4,#!+'$#/8,D!C0+$H!/!#$005/)*!$%!/!+'$#/8,!
'$!/!-#,E&$3+07!)#,/',9!+./-+4$'!&+!-$++&50,D!
LOKP;OR;KR! \1@!B-,#/'&$.+! ]&'4&.!'4,!\1@!$-,#/'&$.+!6,'4$9+!'4,#,!&+!/!.,:!-/#/6,',#!
)/00,9!U94)-C)'&E,U!'$!,./50,!$#!9&+/50,!"#$%&'(#&)*+!=V@"!
%/)&0&'7!%$#!&.9&E&93/0!\1@+D!F4&+!/00$:+!+,''&.8!3-!7$3#!$:.!
=V@"D!
LOKP;O^;KR! 2,#E,#!B-,#/'&$.+! Y&#'3/0!2,#E,#+!)/.!5,!U+'/#',9UH!U+'$--,9U!/.9!U#,+,',9UD!
U243'9$:.U!/.9!UZ,5$$'U!/#,!.$'!/E/&0/50,!/.76$#,D!F4,+,!
$-,#/'&$.+!4/E,!'$!5,!,G,)3',9!$.!'4,!Y_!9&#,)'07D!
LOKP;O`;PO! createStorage! F4,!6,'4$9!)$.'/&.+!/!.,:!$-'&$./0!-/#/6,',#!'$!9,%&.,!/!
)3+'$6&J,9!&6/8,!#$$'!0$8&.!-/++:$#9!%$#!/.7!V==!&6/8,!
-#$E&9,9!57!"#$%&'(#&)*+D!
ProfitBricks API Documentation v1.2
8 / 72
Fundamentals
(D*C"E%*!"$+&!
F$!5,'',#!3.9,#+'/.9!'4,!&.',.9,9!3+/8,!$%!"#$%&'(#&)*+!C"1H!/!+,#&,+!$%!)$.),-'+!3+,9!
'4#$384$3'!'4&+!9$)36,.'!.,,9!'$!5,!&.'#$93),9D!
,@<:46F&C6:6&)87:8<&
C!+,'!$%!E&#'3/0!)$6-$.,.'+!?+,#E,#+H!+'$#/8,!9,E&),+H!0$/9!5/0/.),#+H!%&#,:/00+H!,')A!/.9!'4,!
#,0/'&$.+!/.9!)$..,)'&$.+!)$.%&83#,9!5,':,,.!'4,6D!1'+!0/7$3'!/.9!)$6-$+&'&$.!)/.!5,!
)4/.8,9!'4#$384!'4,!=@=!/.9!'4#$384!'4,!C"1!'4&+!9$)36,.'!9,+)#&5,+D!
,@<:46F&+8<?8<&
C.!&.9&E&93/0!E&#'3/0!6/)4&.,!:4$+,!)$.%&83#/50,!-/#/6,',#+!/#,!'4,!0&*,!$%M!.365,#!$%!)$#,+H!
ZC_!6,6$#7H!,')D!C'!'4,!'&6,!$%!:#&'&.8H!/)'&E/'&.8!)4/.8,+!&.!'4,!-/#/6,',#+!$%!/!#3..&.8!
+,#E,#!#,S3&#,+!#,5$$'&.8D!1.!'4,!.,G'!%3'3#,!+3)4!)$.+'#/&.'!:&00!5,!#,6$E,9D!
,@<:46F&+:3<6G8&
C!50$)*!9,E&),!'4/'!)/.!5,!)$..,)',9!'$!/!+,#E,#!$%%,#&.8!5/+&)!9/'/!+'$#/8,!)/-/5&0&'&,+D!
.H6G8&
C.!&6/8,!&+!/!+&.80,!%&0,H!)$.'/&.&.8!'4,!)$6-0,',!)$.',.'+!/.9!+'#3)'3#,!$%!/!9/'/!6,9&36!$#!
9,E&),H!:4&)4!)/.!5,!3+,9!'$!&.&'&/0&J,!/!+'$#/8,!9,E&),D!F4,!3+,#!)/.!,&'4,#!)4$$+,!%#$6!
"#$%&'(#&)*+!9,%/30'!&6/8,+!$#!3-0$/9!&.9&E&93/0!&6/8,+!E&/!XF"!/.9!/++&8.!'4,6!'$!@=;
ZB_N=Y=!9#&E,+!$#!E&#'3/0!+'$#/8,!9,E&),+D!
14>F@5&$"*&
C!0$)/0!/#,/!?+35A.,':$#*!:4&)4!4/+!/)),++!'$!'4,!&.',#.,'D!C!#/.9$6!=V@"!1"!/99#,++!&+!
5,&.8!/++&8.,9!'$!'4,!\1@!$%!/!+,#E,#!&.!/!aC\!/3'$6/'&)/007!57!"#$%&'(#&)*+D!F4,!=V@"!1"!
/99#,++!:&00!)4/.8,!,E,.'3/007!57!+$6,!.,':$#*!$-,#/'&$.+H!0&*,!#,5$$'&.8!/!+,#E,#!$#!
9&+)$..,)'&.8!/.9!#,)$..,)'&.8!'4,!aC\!'$!'4,!&.',#.,'D!F4$384H!'4,!3+,#!)/.!#,+,#E,!%&G,9!
-350&)!1"!/99#,++,+!/.9!/++&8.!'4,6!6/.3/007!'$!/!\1@D!2,E,#/0!-350&)!1"!/99#,++,+!)/.!$.07!
5,!#,+,#E,9!50$)*;:&+,D!!
1<@?6:8&$"*&
C!0$)/0!/#,/!?+35A.,':$#*!:4&)4!4/+!.$!/)),++!'$!'4,!&.',#.,'D!"#&E/',!1"+!)/.!5,!+-,)&%&,9!
/.9!/++&8.,9!6/.3/007D!Y/0&9!1"!/99#,++,+!%$#!-#&E/',!?+35A.,':$#*+!/#,!KODODODONQH!
KRLDK^DODONKL!$#!KbLDK^QDODONK^!!
ProfitBricks API Documentation v1.2
9 / 72
,@<:46F&-8934<589&+:6:8&
C!Y&#'3/0!Z,+$3#),!?Y&#'3/0!2,#E,#H!Y&#'3/0!2'$#/8,H!Y&#'3/0!=/'/!@,.',#A!:&00!5,H!/'!/.7!8&E,.!
6$6,.'H!&.!/!),#'/&.!+'/',D!!
F4,!C"1!&+!3+,9!57!)0&,.'+!'$!+,.9!#,S3,+'+H!/+!9,+)#&5,9!&.!'4,!C"1!6,'4$9+H!'$!)#,/',!$#!
6/./8,!/!Y&#'3/0!=/'/!@,.',#D!C+!+$$.!/+!/!#,S3,+'!4/+!5,,.!+,.9H!/!.,:!E&#'3/0!#,+$3#),!
:&'4!/!3.&S3,!&9,.'&%&,#!&+!5,&.8!)#,/',9!/.9!'4,#,:&'4!+'/#'+!&'c+!E&#'3/0!#,+$3#),!0&%,!)7)0,D!
Z&84'!/%',#!'4,!+7+',6!#,),&E,9!/!#,S3,+'H!/!&9,.'&%&,#!$%!'4,!.,:!E&#'3/0!#,+$3#),!&+!5,&.8!
#,+-$.9,9!5/)*!'$!'4,!)0&,.'D!F4&+!&9,.'&%&,#!)/.!5,!3+,9!57!'4,!)0&,.'!'$!8,'!/00!9,+&#,9!
&.%$#6/'&$.!/5$3'!'4,!#,+-,)'&E,!#,+$3#),H!&.)039&.8!&'+!-#$E&+&$.&.8!+'/',!93#&.8!&'+!0&%,!)7)0,H!
3.'&0!'4,!E&#'3/0!#,+$3#),!4/+!5,,.!9,0,',9D!
!
$@I8&)J5F8&3I&6&,@<:46F&-8934<58&K1<3?@9@37@7G&+:6:89L&
F4&+!9&/8#/6!9,+)#&5,+!'4,!E&#'3/0!#,+$3#),+!+'/',+!?0&%,!)7)0,A!93#&.8!/!-#$E&+&$.&.8!-#$),++D!!!
&
M878<6F&1<3?@9@37@7G&+:6:89&KI3<&A6:6&587:8<N&98<?8<&67A&9:3<6G8L&
INACTIVE W+,#!#,S3,+'!%$#!.,:!#,+$3#),!4/+!5,,.!#,),&E,9!/.9!+)4,930,9!
INPROCESS "#$E&+&$.&.8!&.!-#$),++D!1.!)/+,!'4,!3+,#!&+!+,.9&.8!.,:!#,S3,+'+!:4&0,!-#$E&+&$.&.8!
&+!+'&00!&.!-#$8#,++H!'4,!#,S3,+'+!:&00!5,!+)4,930,9!57!'4,!+7+',6!'$!5,!-#$),++,+!/'!
'4,!.,G'!-#$E&+&$.&.8!
AVAILABLE C00!#,S3,+'+!)$6-0,',9!+3)),++%3007D!=/'/!),.',#!$#!9,E&),+!&+N/#,!#,/97!%$#!3+,!
DELETED =/'/!),.',#!$#!$5I,)'+!4/+N4/E,!5,,.!9,0,',9!
+B85@I@5&+8<?8<&+:6:89&
NOSTATE F4,!Y&#'3/0!2,#E,#!4/+!.$!+'/',!?,&'4,#!&%!-#$E&+&$.&.8!&+!+'&00!&.!-#$),++!$#!&%!
-#$E&+&$.&.8!:/+!+3)),++%30H!53'!'4,!Y&#'3/0!2,#E,#!%/&0,9!'$!5$$'!%#$6!'4,!+,0,)',9!
9,E&),A!
RUNNING F4,!Y&#'3/0!2,#E,#!&+!#3..&.8!
BLOCKED F4,!Y&#'3/0!2,#E,#!50$)*,9!/.9!.$'!#3..&.8D!F4&+!&+!/!)$66$.!&90,!+'/',!,D8D!&%!'4,!
+,#E,#!&+!:/&'&.8!%$#!1NB!!
ProfitBricks API Documentation v1.2
10 / 72
PAUSE F4,!Y&#'3/0!2,#E,#!4/+!5,,.!-/3+,9D!]4&0,!&.!-/3+,9!+'/',H!'4,!Y&#'3/0!2,#E,#!:&00!
+'&00!)$.+36,!/00$)/',9!#,+$3#),+!0&*,!6,6$#7!53'!:&00!.$'!5,!,0&8&50,!%$#!+)4,930&.8!
SHUTDOWN F4,!Y&#'3/0!2,#E,#!&+!&.!'4,!-#$),++!$%!8,''&.8!+43'!9$:.!-#$-,#07!57!'4,!B2!
SHUTOFF F4,!Y&#'3/0!2,#E,#!&+!+43'!$%%!
CRASHED F4,!Y&#'3/0!2,#E,#!4/+!5,,.!)#/+4,9!
ProfitBricks API Documentation v1.2
11 / 72
Resource Limits
-%+'D-)%&$.E.!+&
C00!/))$3.'+!4/E,!9,%/30'!0&6&'+!:4&)4!/#,!&.',.9,9!'$!6/./8,!)/-/)&'7!/.9!-#,E,.'!/53+,D!!
!
F4,#,!/#,!':$!*&.9!$%!+7+',6!:&9,!#,+$3#),!0&6&'+M!!
Default Resource Limit per DeviceH!:4&)4!&+!%&G,9!/.9!)/..$'!5,!,G),,9,9D!
Default Resource Limit per AccountH!:4&)4!&+!+,'D!]4,.!.,),++/#7H!'4&+!0&6&'!)/.!5,!&.)#,/+,9!$.!)3+'$6,#d+!9,6/.9!57!'4,!"#$%&'(#&)*+!23--$#'!F,/6D!!
+J9:8HO@A8&C8I64F:&-8934<58&$@H@:9&B8<&C8?@58&
Resources Default Limit
@$#,+!-,#!Y&#'3/0!2,#E,#! eQ!
\1@+!-,#!Y&#'3/0!2,#E,#! ^!
@=;ZB_N=Y=;=#&E,!-,#!Y&#'3/0!2,#E,#!! L!
\365,#!$%!Y&#'3/0!2'$#/8,+!-,#!Y&#'3/02,#E,#! Q!
_,6$#7!-,#!Y&#'3/0!2,#E,#! LOOROe!_&(!
2'$#/8,!2-/),!-,#!Y&#'3/0!2'$#/8,! LObRK`L!_&(!?LOeQ!f&(A!
+J9:8HO@A8&C8I64F:&-8934<58&$@H@:9&B8<&"55347:&
Resources Default Limit
@$#,+!-,#!C))$3.'! PLO!
_,6$#7!-,#!C))$3.'! PLR^QO!_&(!
2'$#/8,!2-/),!-,#!C))$3.'! `LeLQQO!_&(!?`KLO!f&(A!
ProfitBricks API Documentation v1.2
12 / 72
API Outline
"1.&'D!$.*%&Authentication
"D!0%*!.)"!.'*&!
"#$%&'(#&)*+!C"1!&+!/!2BC"!:,5!+,#E&),!$%%,#,9!'$!&'+!3+,#+!$E,#!/!Fa2!'#/.+-$#'!)$65&.,9!:&'4!
VFF"!(/+&)!/3'4,.'&)/'&$.D!F4,!)3+'$6,#!:&00!.,,9!'$!)$.%&83#,!'4,&#!2BC"!)0&,.'!:&'4!3+,#!
)#,9,.'&/0+!?3+,#./6,H!-/++:$#9A!$5'/&.,9!'4#$384!'4,!"#$%&'(#&)*+!:,5+&',D!!
C3'4,.'&)/'&$.!#,S3,+'+!/.9!9/'/!),.',#!$-,#/'&$.+!/#,!-,#%$#6,9!3+&.8!22a!$E,#!VFF"!
?VFF"2A!%$#!9/'/!)$.%&9,.'&/0&'7!/.9!&.',8#&'7D
SOAP Request
+'"1&-%PD%+!&!
C.7!#,S3,+'+!)$.%$#6+!'$!/!g_a!+)4,6/H!:4&)4!&+!9,%&.,9!/+!-/#'!$%!"#$%&'(#&)*+!]2=aH!
:4,#,57!%$#!,/)4!%3.)'&$.!$-'&$./0!/.9!6/.9/'$#7!-/#/6,',#+!/#,!:,00!9,%&.,9D!
%Q6HBF8=&+'"1&-8R489:&&
// SOAP REQUEST TO CREATE A DATA CENTER
<soapenv:Envelope
xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ws=”http://ws.api.profitbricks.com/”>
<soapenv:Header>
</soapenv:Header>
<soapenv:Body>
<ws:createDataCenter>
<dataCenterName>abc</dataCenterName>
</ws:createDataCenter>
</soapenv:Body>
</soapenv:Envelope>
SOAP Response
+'"1&-%+1'*+%&!
C.7!#,S3,+'+!)$.%$#6+!'$!/!g_a!+)4,6/H!:4&)4!&+!9,%&.,9!/+!-/#'!$%!"#$%&'(#&)*+!]2=aH!
:4,#,57!%$#!,/)4!%3.)'&$.!$-'&$./0!/.9!6/.9/'$#7!-/#/6,',#+!/#,!:,00!9,%&.,9D!
ProfitBricks API Documentation v1.2
13 / 72
)3HH37&<89B3798&I@8FA9&I3<&"1.&56FF9=&
Parameter Description Included in
requestId C!3.&S3,!+'#&.8!/++&8.,9!'$!,/)4!#,S3,+'!57!'4,!"#$%&'(#&)*+!C"1D!C00!
#,S3,+'+!/#,!#,)$#9,9D!F4,#,%$#,H!'4,!"#$%&'(#&)*+!23--$#'!F,/6!&+!/50,!
'$!&9,.'&%7!/00!&++3,+!57!&'+!1=H!&.!)/+,!'4,!3+,#!#,S3&#,+!+3--$#'!%$#!
'#$350,+4$$'&.8!
C00!#,S3,+'+!
dataCenterId 19,.'&%&,#!$%!'4,!9/'/!),.',#!'4,!#,S3,+'!$-,#/',9!$.! C00!-#$E&+&$.&.8!
#,S3,+'+!
dataCenterVersion =/'/!),.',#!Y,#+&$.H!#,+30'&.8!57!'4,!$-,#/'&$.H!&.)#,6,.'!57!K! C00!-#$E&+&$.&.8!
#,S3,+'+D!
%Q6HBF8=&+'"1&-89B3798&&
// SOAP Request to create a data center
<S:Envelope xmlns:S=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:xs=”http://www.w3.org/2001/XMLSchema”>
<S:Header>
</S:Header>
<S:Body>
<ns2:createDataCenterResponse
xmlns:ns2=”http://ws.api.profitbricks.com/”>
<return>
<requestId>1163</requestId>
<dataCenterId>4b98319a-125e-4d1a</dataCenterId>
<dataCenterVersion>1</dataCenterVersion>
</return>
</ns2:createDataCenterResponse>
</S:Body>
</S:Envelope>
SOAP Fault & Error Codes
+'"1&("D$!&S&%--'-&)'C%+&',%-,.%/&!
C%',#!#,),&E&.8!/!#,S3,+'H!'4,!+7+',6!:&00!)4,)*!%$#!)0&,.'!#,0/',9!,##$#+D!1%!/.!,##$#!$))3#+H!/!
2BC"!%/30'!6,++/8,!:&00!5,!#,'3#.,9D!F4,!%$00$:&.8!,##$#!&.%$#6/'&$.!)/.!5,!%$3.9!&.!2BC"!
%/30'!6,++/8,+M!
%/30'@$9,!/.9!4''-@$9,H!$#8/.&J,9!&.!9&%%,#,.'!,##$#!+),./#&$+!8#$3-+!
ProfitBricks API Documentation v1.2
14 / 72
%300!,##$#!6,++/8,+H!#,/9/50,!57!'4,!%#$.'!,.9!3+,#!
&
%Q6HBF8=&+'"1&(64F:&-89B3798&
// SOAP Fault Response of a data center
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Header />
<S:Body>
<S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
<faultcode>S:Server</faultcode>
<faultstring>RAM of requested server too small, 256 Mb is
minimum</faultstring>
<detail>
<ns2:ProfitbricksServiceFault
xmlns:ns2="http://ws.api.profitbricks.com/">
<faultCode>BAD_REQUEST</faultCode>
<httpCode>400</httpCode>
<message>RAM of requested server too small, 256
Mb is minimum</message>
<requestId>1045</requestId>
</ns2:ProfitbricksServiceFault>
</detail>
</S:Fault>
</S:Body>
</S:Envelope>
%--'-&)'C%+&',%-,.%/&!
%<<3<&)3A89&&
HTTP Code Code Expected In
eOO! BAD_REQUEST C00!
eOK! UNAUTHORIZED C00!
eOe! RESOURCE_NOT_FOUND C00!
eOb! PROVISIONING_IN_PROCESS =,0,'&.8!/!9/'/!),.',#!
ProfitBricks API Documentation v1.2
15 / 72
eOb! PROVISIONING_NO_CHANGES W-9/'&.8!,G&+'&.8!#,+$3#),+!
eKO! RESOURCE_DELETED f,'!%3.)'&$.+!
eKP! OVER_LIMIT_SETTING Z,S3,+'!.,:!#,+$3#),+!
`OP! SERVER_EXCEEDED_CAPACITY Z,S3,+'!.,:!#,+$3#),+!
`OP! UNEXPECTED C00!
C8:6@F9&67A&%Q6HBF89=&
400 BAD_REQUEST
[G/6-0,M!1.E/0&9!./6,!-/#/6,',#+H!6&++&.8!6/.9/'$#7!-/#/6,',#+H!,')D!
401 UNAUTHORIZED
F4,!3+,#!9$,+!.$'!4/E,!/)),++!-,#6&++&$.!'$!/.7!#,+$3#),+!&.!'4&+!9/'/!),.',#D!
404 RESOURCE_NOT_FOUND
F4,!#,S3,+'!#,+$3#),!9$,+!.$'!,G&+'!$#!4/+!5,,.!9,0,',9!57!'4,!3+,#D!
409 PROVISIONING_NO_CHANGES
F4,!#,S3,+'!9$,+!.$'!/--07!/.7!)4/.8,+!&.!'4,!/)'&E,!9/'/!),.',#D!!
[G/6-0,M!)$..,)'!/!+'$#/8,!'$!/!+,#E,#H!:4&)4!&+!/0#,/97!)$..,)',9D!
413 OVER_LIMIT_SETTING
Z,S3,+'!,G),,9+!'4,!#,+$3#),N/))$3.'!0&6&'D!2,,!/0+$!<eD!Z,+$3#),!a&6&'+>D!
503 SERVER_EXCEED_CAPACITY
F4,!#,S3,+'!)/..$'!5,!-,#%$#6,9H!5,)/3+,!'4,!#,S3,+'!,G),,9+!&'+!+,#E&),d+!)/-/)&'7D!!
[G/6-0,M!'4,!+7+',6!)/..$'!#,+,#E,!/!5&8!50$)*!$%!-350&)!1"!/99#,++,+D!
503 UNEXPECTED
W+,#+!+4$309!)$.'/)'!"#$%&'(#&)*+!23--$#'!F,/6!?#,S3,+'19!&+!#,S3&#,9AD!
ProfitBricks API Documentation v1.2
16 / 72
API Methods
"1.&E%!0'C+&!
F4,!%$00$:&.8!+,)'&$.!9,+)#&5,+!/00!$-,#/'&$.+!)3##,.'07!/E/&0/50,!'4#$384!"#$%&'(#&)*+!C"1D!
B-,#/'&$.+!%$#!)#,/'&.8H!3-9/'&.8!/.9!9,0,'&.8!#,+$3#),+!/#,!)$.+&9,#,9!-#$E&+&$.&.8!,E,.'+D!
[##$#+!4/--,.&.8!:4&0,!-#$),++&.8!'4$+,!,E,.'+!/#,!/--#$-#&/',07!+&8./0,9!'$!'4,!)0&,.'!
/--0&)/'&$.!'4#$384!'4,!3+/8,!$%!2BC"!X/30'+D!
User Notifications
D+%-&*'!.(.)"!.'*&'1%-"!.'*+&!
W+,9!'$!/)),++!.$'&%&)/'&$.+!'4,!+7+',6!+,.9+!'$!+&8./0!+-,)&%&)!,E,.'+D!
F4,+,!,E,.'!$%',.!#,S3&#,!3+,#!&.',#/)'&$.H!+$!'4,!)3##,.'!.$'&%&)/'&$.+!+4$309!5,!)4,)*,9!%#,S3,.'07D!
.7A8Q&
!"#$%&#'(')*#'&+,&
-"."#"$%&#'(')*#'&+, Get Notifications
M%!&*'!.(.)"!.'*+&!
f,'+!/00!)3##,.'!?.$'!9,0,',9A!3+,#!.$'&%&)/'&$.+D!
W+,#!.$'&%&)/'&$.+!/#,!)#,/',9!57!'4,!+7+',6!'$!&.%$#6!3+,#+!/5$3'!9&%%,#,.'!,E,.'+!
)$.),#.&.8!,D8D!'4,&#!9/'/!),.',#+D!
\$'&%&)/'&$.+!+'/7!&.!'4,!S3,3,!3.'&0!9,0,',9!?+!,,!9,0,',\$'&%&)/'&$.+AH!+$!/!.$'&%&)/'&$.!6/7!
5,!#,/9!#,-,/',907!:&'4!!
8,'\$'&%&)/'&$.+D!
!
getNotifications(): List<Notification>
!
-8R489:&B6<6H8:8<9&&
Name Description Required
networkUUID W3&9!$%!'4,!.,':$#*!'4,!.$'&%&)/'&$.!#,%,#+!'$! !!7,+!
-89B3798&B6<6H8:8<9&&
Name Description
id 19,.'&%&,#!$%!'4,!'4&+!.$'&%&)/'&$.!
ProfitBricks API Documentation v1.2
17 / 72
networkUUid W3&9!$%!'4,!.,':$#*!'4,!.$'&%&)/'&$.!#,%,#+!'$!
timestamp @#,/'&$.!'&6,!$%!'4&+!.$'&%&)/'&$.!
messageCode B.,!$%!c_,++/8,@$9,+cH!+,,!5,0$:!
relatedItemType B.,!$%!c1',6F7-,+cH!+,,!5,0$:!
relatedItemUuid 19!$%!+-,)&%&)!)$6-$.,.'!$%!'7-,!c#,0/',91',6F7-,c!'4/'!'4,!6,++/8,!
)$.),#.+!
message F,G'3/0!6,++/8,!
&&
E8996G8&)3A89&&
Name Description
SHUTDOWN_SERVER_FAILED 243'9$:.!$%!/!+,#E,#!%/&0,9D!W+,#!&.',#/)'&$.!#,S3&#,9!'$!,.+3#,!
-#$-,#!+7+',6!+'/',D!2,,!#,0/',91',6W3&9!%$#!'4,!+,#E,#!&9D!
OTHER \$.;'7-,9!.$'&%&)/'&$.!
-8F6:8A&.:8H&!JB8&&
Name Description
TYPE_SERVER _,++/8,!)$.),#.+!/!+,#E,#!
TYPE_STORAGE _,++/8,!)$.),#.+!/!+'$#/8,!
TYPE_IMAGE _,++/8,!)$.),#.+!/.!&6/8,!
TYPE_LOADBALANCER _,++/8,!)$.),#.+!/!0$/9!5/0/.),#!
TYPE_NIC _,++/8,!)$.),#.+!/!.,':$#*!&.',#%/),!)/#9!
TYPE_FIREWALL _,++/8,!)$.),#.+!/!%&#,:/00!
TYPE_OTHER _,++/8,!)$.),#.+!/.!$'4,#!)$6-$.,.'!$#!3.+-,)&%&,9!
%<<3<&)3A89&&
*378&
Delete Notifications
C%$%!%&*'!.(.)"!.'*+&!
=,0,',+!'4,!.$'&%&)/'&$.+!:&'4!'4,!8&E,.!&9+D!
!
deleteNotifications (List<String> notificationId): void
!
ProfitBricks API Documentation v1.2
18 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
notificationId 19!$%!/!.$'&%&)/'&$.!'$!9,0,',! !!7,+!
-89B3798&B6<6H8:8<9&&
*378&
%<<3<&)3A89&&
Code Description
RESSOURCE_NOT_FOUND C!.$'&%&)/'&$.!:&'4!$.,!$%!'4,!8&E,.!&9+!:/+!.$'!%$3.9!N!:/+!9,0,',9!
/0#,/97D!
Virtual Data Center Operations
,.-!D"$&C"!"&)%*!%-&'1%-"!.'*+&!
.7A8Q=&
/0"*#"$-*#*$/"+#"0&
!"#$-*#*$/"+#"0$12$3-&
!"#$-*#*$/"+#"0$4#*#"&
!"#$5..$-*#*$/"+#"0,&
678*#"$-*#*$/"+#"0&
/."*0$-*#*$/"+#"0&
-"."#"$-*#*$/"+#"0 Create Data Center
)-%"!%&C"!"&)%*!%-&!
@#,/',+!/.9!+/E,+!/!.,:H!,6-'7!Y&#'3/0!=/'/!@,.',#D!Z,'3#.+!&'+!&9,.'&%&,#!%$#!%3#'4,#!
#,%,#,.),D!
!
ProfitBricks API Documentation v1.2
19 / 72
createDataCenter(dataCenterName : String, region : Region):
CreateDcResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
dataCenterName \/6,+!'4,!.,:!E&#'3/0!9/'/!),.',#D!1%!.$!./6,!&+!+-,)&%&,9H!
'4,!9/'/!),.',#!:&00!5,!./6,9!<W../6,9!=/'/!@,.',#>!57!
9,%/30'D!
region 2,0,)'!#,8&$.!'$!)#,/',!'4,!9/'/!),.',#!?\BZFVhC_[Z1@CH!
[WZB"[H!=[XCWaFAD!!
1%!+,'!'$!=[XCWaF!$#!0,%'!,6-'7H!9/'/!),.',#!:&00!5,!)#,/',9!
&.!'4,!9,%/30'!#,8&$.!$%!'4,!)3+'$6,#!
&T& *6H@7G&-89:<@5:@379&=/'/!),.',#!./6,+!)/..$'!+'/#'!:&'4!$#!)$.'/&.!?iH!NH!jH!kH!ldH!lA!
&T&.HB3<:67:&.7I3<H6:@37&6>34:&6&C6:6&)87:8<9&-8G@37&
F4,!9,%/30'!#,8&$.!&+!+,'!/))$#9&.8!'$!'4,!0$)/'&$.!+'/',9!&.!'4,!#,8&+'#/'&$.!-#$),++D!m$3!)/.!+,'!
'4,!#,8&$.!,G-0&)&'07!:4&0,!)#,/'&.8!/!9/'/!),.',#D!
B.),!+,'!/.9!/--0&,9H!/!9/'/!),.',#c+!0$)/'&$.!)/..$'!5,!)4/.8,9!/.76$#,D!C0+$H!5,!/:/#,!'4/'!
9/'/!),.',#+!%#$6!9&%%,#,.'!#,8&$.+!/#,!&+$0/',9!%#$6!,/)4!$'4,#D!1'!&+!.$'!-$++&50,!'$!6$E,!/!9/'/!
),.',#!$#!,0,6,.'+!$%!/!9/'/!),.',#!%#$6!$.,!#,8&$.!'$!/.$'4,#D!!
-89B3798&B6<6H8:8<9&&
Name Description
dataCenterId 19,.'&%&,#!$%!'4,!E&#'3/0!9/'/!),.',#!
region Z,8&$.!:4,#,!'4,!9/'/!),.',#!4/+!5,,.!)#,/',9!?\BZFVhC_[Z1@CH!
[WZB"[A!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!3+,9!&.!'4,!E&#'3/0!9/'/!),.',#!./6,!
Get Data Center by ID
M%!&C"!"&)%*!%-&.C&!
Z,'3#.+!&.%$#6/'&$.!/5$3'!/.!,G&+'&.8!E&#'3/0!9/'/!),.',#d+!+'/',!/.9!)$.%&83#/'&$.D!
!
getDataCenter(dataCenterId : String): DataCenter
ProfitBricks API Documentation v1.2
20 / 72
!
-8R489:&B6<6H8:8<9&&
Name Description Required
dataCenterId 19,.'&%&,#!$%!'4,!E&#'3/0!9/'/!),.',#! m,+!
!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
dataCenterName \/6,!$%!'4,!.,:!E&#'3/0!9/'/!),.',#!
provisioningState =,+)#&5,+!'4,!)3##,.'!+'/',!$%!'4,!+-,)&%&,9!9/'/!),.',#!
?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H[ZZBZA!
servers C!0&+'!$%!/00!E&#'3/0!+,#E,#+D!2,,!/0+$ Get Server [6-'&/50,!
storages C!0&+'!$%!/00!E&#'3/0!+'$#/8,+D!2,,!/0+$ Get Storage [6-'&/50,!
region Z,8&$.!:4,#,!'4,!9/'/!),.',#!4/+!5,,.!)#,/',9!
?\BZFVhC_[Z1@CH![WZB"[A!
loadBalancers C!0&+'!$%!/00!E&#'3/0!0$/9!5/0/.),#+D!2,,!/0+$!Get Load Balancer!
[6-'&/50,!
!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND =/'/!@,.',#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!9/'/!),.',#!
Get Data Center State
M%!&C"!"&)%*!%-&+!"!%&!
F4&+!&+!/!0&84':,&84'!%3.)'&$.!%$#!-$$0&.8!'4,!)3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!Y&#'3/0!=/'/!
@,.',#D!1'!&+!#,)$66,.9,9!'$!3+,!'4&+!%3.)'&$.!%$#!0/#8,!Y&#'3/0!=/'/!@,.',#+!'$!S3,#7!#,S3,+'!
#,+30'+D!
!
getDataCenterState(dataCenterId : String): ProvisioningState
!
-89B3798&B6<6H8:8<9&&
Name Description
provisioningState "#$E&+&$.&.8!2'/',!$%!'4,!'/#8,'!Y&#'3/0!=/'/!@,.',#!?1\C@F1Y[H!
1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!
&
ProfitBricks API Documentation v1.2
21 / 72
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND =/'/!@,.',#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!9/'/!),.',#!
Get All Data Centers
M%!&"$$&C"!"&)%*!%-+&&
Z,'3#.+!/!0&+'!$%!/00!Y&#'3/0!=/'/!@,.',#+!)#,/',9!57!'4,!3+,#H!&.)039&.8!1=H!./6,!/.9!E,#+&$.!
.365,#D!
!
getAllDataCenters(): List<DataCenterIdentifier>
!
-89B3798&B6<6H8:8<9&&
Name Description
dataCenterId 19,.'&%&,#!$%!'4,!E&#'3/0!9/'/!),.',#!
dataCenterName \/6,!$%!'4,!E&#'3/0!9/'/!),.',#!
dataCenterVersion Y,#+&$.!$%!'4,!E&#'3/0!9/'/!),.',#!
Update Data Center
D1C"!%&C"!"&)%*!%-&
W-9/',+!'4,!&.%$#6/'&$.!/++$)&/',9!'$!/.!,G&+'&.8!Y&#'3/0!=/'/!@,.',#D!!
!
updateDataCenter(request : UpdateDcRequest)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
dataCenterId 19,.'&%&,#!$%!'4,!E&#'3/0!9/'/!),.',#! m,+!
dataCenterName Z,./6,+!'4,!'/#8,'!E&#'3/0!9/'/!),.',#!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!3+,9!&.!'4,!E&#'3/0!9/'/!),.',#!./6,!
RESOURCE_NOT_FOUND 1.E/0&9!9/'/!),.',#!&9,.'&%&,#!N!2-,)&%&,9!9/'/!),.',#!1=!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!9/'/!),.',#!
!
ProfitBricks API Documentation v1.2
22 / 72
&T& *3:8&1'!&+!$.07!-$++&50,!'$!3-9/',!'4,!Y&#'3/0!=/'/!@,.',#!./6,!/'!'4,!6$6,.'D!
Clear Data Center
)$%"-&C"!"&)%*!%-&
Z,6$E,+!/00!)$6-$.,.'+!%#$6!/.!,G&+'&.8!Y&#'3/0!=/'/!@,.',#D!!
!
clearDataCenter(dataCenterId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
dataCenterId 19,.'&%&,#!$%!'4,!E&#'3/0!9/'/!),.',#! m,+!
%<<3<&)3A89&&
Code Description
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!9/'/!),.',#!
RESOURCE_NOT_FOUND 1.E/0&9!9/'/!),.',#!&9,.'&%&,#!N!2-,)&%&,9!9/'/!),.',#!1=!9$,+!.$'!,G&+'!
Delete Data Center
C%$%!%&C"!"&)%*!%-&
=,0,',+!/.!Y&#'3/0!=/'/!@,.',#D!1%!/!-#,E&$3+!#,S3,+'!$.!'4,!'/#8,'!9/'/!),.',#!&+!+'&00!&.!
-#$8#,++H!'4,!9/'/!),.',#!&+!8$&.8!'$!5,!9,0,',9!/%',#!'4&+!#,S3,+'!4/+!5,,.!)$6-0,',9D!B.),!
/!=/'/!@,.',#!4/+!5,,.!9,0,',9H!.$!%3#'4,#!#,S3,+'!)/.!5,!-,#%$#6,9!$.!&'D!!
!
deleteDataCenter(dataCenterId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
dataCenterId 19,.'&%&,#!$%!'4,!E&#'3/0!9/'/!),.',#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 1.E/0&9!9/'/!),.',#!&9,.'&%&,#!N!2-,)&%&,9!9/'/!),.',#!1=!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!9/'/!),.',#!
ProfitBricks API Documentation v1.2
23 / 72
+J9:8H&H8996G89&<8:4<7@7G&37&<8R489:&A4<@7G&6&A8F8:@37&B<35899&
Code Description
PROVISIONING_IN_PROCESS =/'/!@,.',#!&+!5,&.8!9,0,',9H!-#$),++!.$'!%&.&+4,9!7,'!
+J9:8H&H8996G89&<8:4<7@7G&37&<8R489:&6I:8<&6&A8F8:@37&B<35899&;69&>887&I@7@9;8A&
Code Description
RESOURCE_DELETED =/'/!@,.',#!4/+!5,,.!9,0,',9!
&T&*3:8&
F4,!)$66/.9!9,0,',=/'/@,.',#!:&00!9,0,',!'4,!9/'/!),.',#D!(,!/:/#,!'4/'!'4,#,!:&00!5,!
.$!#$00!5/)*!$-'&$.H!+$!5,!-0,/+,!3+,!'4&+!)$66/.9!9,0&5,#/',07D!
Server Operations
+%-,%-&'1%-"!.'*+&!
.7A8Q=&
/0"*#"$4"09"0&
!"#$4"09"0&
!"#$5..$4"09"0,&
:","#$4"09"0&
4#*0#$4"09"0&
4#&7$4"09"0&
678*#"$4"09"0&
-"."#"$4"09"0&
Create Server
)-%"!%&+%-,%-&&
@#,/',+!/!Y&#'3/0!2,#E,#!:&'4&.!/.!,G&+'&.8!9/'/!),.',#D!"/#/6,',#+!)/.!5,!+-,)&%&,9!'$!+,'!3-!
ProfitBricks API Documentation v1.2
24 / 72
/!5$$'!9,E&),!/.9!)$..,)'!'4,!+,#E,#!'$!/.!,G&+'&.8!aC\!$#!'4,!1.',#.,'D!
!
createServer(request : CreateServerRequest): CreateServerResponse
&T&!
F4,!-/#/6,',#+!0/.19!/.9!&.',#.,'C)),++!/#,!+3&'/50,!%$#!%/+'!+,#E,#!+'/#';3-+D!X$#!,G/6-0,H!/!
.,:!+,#E,#!:&'4!&.',#.,'!/)),++!)/.!5,!+'/#',9!S3&)*07!57!+&6-07!+,.9&.8!$.,!#,S3,+'!:&'4!'4#,,!
-/#/6,',#+!)$#,+H!#/6!/.9!&.',#.,'C)),++D!2,,!/0+$!Create NIC!
!
-8R489:&B6<6H8:8<9&&
Name Description Required
cores \365,#!$%!)$#,+!'$!5,!/++&8.,9!'$!'4,!+-,)&%&,9!+,#E,#! m,+!
ram \365,#!$%!ZC_!6,6$#7!?&.!_&(A!'$!5,!/++&8.,9!'$!'4,!
+,#E,#D!F4,!6&.&636!ZC_!+&J,!&+!L`^!_&(!
m,+!
dataCenterId =,%&.,+!'4,!9/'/!),.',#!:4,#,&.!'4,!+,#E,#!&+!'$!5,!)#,/',9D!
1%!0,%'!,6-'7H!'4,!+,#E,#!:&00!5,!)#,/',9!&.!/!.,:!9/'/!
),.',#!
serverName \/6,!$%!'4,!+,#E,#!'$!5,!)#,/',9!
bootFromImageId =,%&.,+!/.!,G&+'&.8!@=;ZB_N=Y=!&6/8,!1=!'$!5,!+,'!/+!
5$$'!9,E&),!$%!'4,!+,#E,#D!C!E&#'3/0!@=;ZB_N=Y=!9#&E,!:&'4!
'4,!6$3.',9!&6/8,!:&00!5,!)$..,)',9!'$!'4,!+,#E,#D!2,,!
/0+$!Add CD-ROM/DVD Drive To Server!
bootFromStorageId =,%&.,+!/.!,G&+'&.8!+'$#/8,!9,E&),!1=!'$!5,!+,'!/+!5$$'!
9,E&),!$%!'4,!+,#E,#D!F4,!+'$#/8,!:&00!5,!)$..,)',9!'$!'4,!
+,#E,#!&6-0&)&'07D!2,,!/0+$!Create Storage!
1%!.$'!0,%'!,6-'7H!'4,!53+!'7-,!'$!:4&)4!'4,!+'$#/8,!:&00!5,!
)$..,)',9!&+!Y1ZF1BD!X$#!/!9&%%,#,.'!53+!'7-,!/!+35+,S3,.'!
&.E$)/'&$.!$%!connectStorageToServer!$-,#/'&$.!&+!
#,S3&#,9H!:&'4!busType!/+!/!-/#/6,',#D!
lanId @$..,)'+!'4,!+,#E,#!'$!'4,!+-,)&%&,9!aC\!1=!n!OD!1%!'4,!
#,+-,)'&E,!aC\!9$,+!.$'!,G&+'H!&'!&+!8$&.8!'$!5,!)#,/',9!
internetAccess 2,'!'$!FZW[!'$!)$..,)'!'4,!+,#E,#!'$!'4,!1.',#.,'!E&/!'4,!
+-,)&%&,9!aC\!1=D!1%!'4,!aC\!&+!.$'!+-,)&%&,9H!&'!&+!8$&.8!'$!
5,!)#,/',9!&.!'4,!.,G'!/E/&0/50,!aC\!1=H!+'/#'&.8!:&'4!aC\!
1=!K!
availabilityZone 2,0,)'+!'4,!J$.,!&.!:4&)4!'4,!+,#E,#!&+!8$&.8!'$!5,!)#,/',9!
?CWFBH!oB\[hKH!oB\[hLAD!2,#E,#+!%#$6!9&%%,#,.'!J$.,+!
/#,!0$)/',9!&.!9&%%,#,.'!-47+&)/0!0$)/'&$.+D!1%!+,'!'$!CWFB!$#!
0,%'!,6-'7H!+,#E,#+!:&00!5,!)#,/',9!&.!/!#/.9$6!J$.,!
osType 2,'+!'4,!B2!'7-,!$%!'4,!+,#E,#D!?]1\=B]2H!a1\WgH!BFV[ZH!
W\p\B]\A!!
1%!0,%'!,6-'7H!'4,!+,#E,#!:&00!&.4,#&'!'4,!B2!F7-,!$%!&'+!
+,0,)',9!5$$'!&6/8,!N!+'$#/8,!
!
ProfitBricks API Documentation v1.2
25 / 72
The OS Type of a server must be set to WINDOWS when using a windows image, due to Microsoft’s terms and conditions. The default OS Type of a server is UNKNOWN, when it is booted from an image uploaded by the customer. !
&T&@7:8<78:"55899&
1%!/!.,:!+,#E,#!&+!)#,/',9!&.!/!-#&E/',!aC\H!&'!:&00!/0:/7+!5,!/!-#&E/',!+,#E,#!/.9!)/..$'!
5,!)$..,)',9!'$!'4,!1.',#.,'!57!+,''&.8!&.',#.,'C)),++!'$!FZW[D!!
!
-89B3798&B6<6H8:8<9&&
Code Description
serverId 19,.'&%&,#!$%!'4,!E&#'3/0!+,#E,#!
!
&T&)3<89U-"E&E@7@H4H&&
F4,!/6$3.'!$%!)$#,+!63+'!5,!nq!KD!F4,!ZC_!+&J,!4/+!/!6&.&636!,.%$#),9!E/03,!$%!
L`^!_&(!/.9!/00!ZC_!+&J,+!63+'!5,!/!630'&-0,!$%!+3)4!E/03,!?`KLH!R^QH!,')AD!!
!
%<<3<&)3A89&&
Name Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!&.!'4,!E&#'3/0!+,#E,#!./6,!
]#$.8!5$$'!&6/8,!'7-,!?V==!&6/8,!&.+',/9!$%!@=;ZB_N=Y=A!
F$$!6/.7!5$$'!9,E&),+!?63+'!5,!,&'4,#!+'$#/8,!$#!@=;ZB_N=Y=!
&6/8,A!
1.E/0&9!ZC_!/.9N$#!)$#,+!?)$#,+!r!KH!ZC_!r!L`^!_&(H!ZC_!+&J,!.$'!
/!630'&-0,!$%!L`^A!
OVER_LIMIT_SETTING @$#,+!/.9N$#!ZC_!0&6&'!,G),,9,9D!2,,!/0+$!Resource Limits!%$#!6$#,!9,'/&0+!
RESOURCE_NOT_FOUND ($$'!&6/8,N+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Get Server
M%!&+%-,%-&!
Z,'3#.+!&.%$#6/'&$.!/5$3'!/!E&#'3/0!+,#E,#H!+3)4!/+!)$.%&83#/'&$.H!-#$E&+&$.&.8!+'/'3+H!-$:,#!
+'/'3+H!,')D!
!
getServer(serverId : String): Server
!
&
ProfitBricks API Documentation v1.2
26 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!E&#'3/0!+,#E,#! m,+!
-89B3798&B6<6H8:8<9&
Name Description Constraints
serverId 19,.'&%&,#!$%!'4,!E&#'3/0!+,#E,#! !
serverName B3'-3'+!'4,!./6,!$%!'4,!+-,)&%&,9!E&#'3/0!+,#E,#! [6-'&/50,!
creationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+,#E,#!4/+!5,,.!)#,/',9! \300/50,!
lastModificationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+,#E,#!4/+!0/+'!5,,.!
6$9&%&,9!!
\300/50,!
provisioningState =,+)#&5,+!'4,!)3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+-,)&%&,9!
E&#'3/0!+,#E,#!?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!
=[a[F[=H![ZZBZA!
!
virtualMachineState =,+)#&5,+!'4,!)3##,.'!+,#E,#!+'/',!$%!'4,!+-,)&%&,9!
E&#'3/0!+,#E,#!?\B2FCF[H!ZW\\1\fH!(aB@p[=H!
"CW2[=H!2VWF=B]\H!2VWFBXXH!@ZC2V[=A!
!
cores C6$3.'!$%!)$#,+!/++&8.,9!'$!'4,!+-,)&%&,9!E&#'3/0!+,#E,#! !
ram ZC_!?&.!_&(A!/++&8.,9!'$!'4,!+-,)&%&,9!E&#'3/0!+,#E,#! !
internetAccess Z,'3#.+!FZW[!&%!+,#E,#!&+!)$..,)',9!'$!/!-350&)!aC\! [6-'&/50,!
ips a&+'+!/00!1"!/99#,++,+!/++&8.,9!'$!'4,!+,#E,#! !
nics a&+'+!/00!\1@+!/++&8.,9!'$!'4,!+,#E,#D!2,,!/0+$!Get NIC! [6-'&/50,!
connectedStorages a&+'+!/00!+'$#/8,+!)$..,)',9!'$!'4,!+,#E,#H!&.)039&.8!'4,!
%$00$:&.8!-/#/6,.',#+M!
;!+'$#/8,19M!+'$#/8,!&9,.'&%&,#!
;!+'$#/8,\/6,M!./6,!$%!'4,!+'$#/8,!
;!+&J,M!+'$#/8,!+&J,!?&.!f&(A!
X$#!'4,+,!'4#,,!-/#/6,',#!+,,!/0+$!Create Storage!$#!Get Storage!
;!53+F7-,M!(3+!'7-,!'$!:4&)4!'4,!+'$#/8,!&+!)$..,)',9!
;!9,E&),\365,#M!9,E&),!.365,#!'4,!+'$#/8,!&+!
)$..,)',9!
X$#!'4,+,!':$!-/#/6,',#!+,,!/0+$!Connect Storage!
;!5$$'=,E&),M!/!%0/8H!&.9&)/'&.8!:4,'4,#!+,#E,#!&+!
5$$'&.8!%#$6!'4&+!+'$#/8,!$#!.$'!sFZW[NXCa2[t!
X$#!'4&+!-/#/6,',#!+,,!/0+$!Create Server!
[6-'&/50,!
availabilityZone o$.,!&.!:4&)4!'4,!+,#E,#!&+!0$)/',9!?CWFBH!oB\[hKH!
oB\[hLA!
!
ProfitBricks API Documentation v1.2
27 / 72
romDrives a&+'+!/00!@=;ZB_!9#&E,+!/++&8.,9!'$!'4,!+,#E,#H!
&.)039&.8!'4,!-/#/6,',#+!$%!'4,!@=;ZB_N=Y=+!&6/8,H!
+3)4!/+M!
;!&6/8,19M!@=;ZB_N=Y=!&6/8,!&9,.'&%&,#!
;!&6/8,\/6,M!./6,!$%!'4,!@=;ZB_N=Y=!&6/8,!
;!5$$'=,E&),M!/!%0/8H!&.9&)/'&.8!:4,'4,#!+,#E,#!&+!
5$$'&.8!%#$6!'4&+!9#&E,!$#!.$'!sFZW[NXCa2[t!
2,,!/0+$!Add CD-ROM/DVD Drive To Server!
[6-'&/50,!
osType B2!'7-,!$%!'4,!+,#E,#!?]1\=B]2H!a1\WgH!BFV[ZH!
W\pB]\A!!
!
&T&
*'+!"!%&
C!!f,'!Y&#'3/0!2,#E,#!)$66/.9!#,'3#.+!'4,!+'/',!\B2FCF[!&%!'4,!-#$E&+&$.&.8!&+!+'&00!&.!-#$),++H!!$#!
?&.!)/+,!'4,!-#$E&+&$.&.8!-#$),++!:/+!+3)),++%30A!&%!&'d+!/'',6-'!'$!5$$'!%#$6!'4,!9,%&.,9!5$$'!
9,E&),!4/+!%/&0,9D!
/;J&A389&:;8&M8:&+8<?8<&53HH67A&34:B4:&73&.1&3<&*.)&B6<6H8:8<V&
1%!'4,!8,'!)$66/.9!$3'-3'+!.$!&.%$#6/'&$.!/5$3'!1"!/.9!\1@H!'4,.!'4,!-#$E&+&$.&.8!-#$),++!&+!
-#$5/507!.$'!%&.&+4,9!7,'D!F4,!+,#E,#!4/+!'$!5,!)$..,)',9!'$!'4,!.,':$#*!/.9!CYC1aC(a[!'$!#,'3#.!
'4,+,!-/#/6,',#+D!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED F4,!+,#E,#!4/+!5,,.!9,0,',9!?57!'4,!3+,#A!
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Get All Servers
M%!&"$$&+%-,%-+&!
Z,'3#.+!&.%$#6/'&$.!/5$3'!/00!E&#'3/0!+,#E,#H!+3)4!/+!)$.%&83#/'&$.H!-#$E&+&$.&.8!+'/'3+H!-$:,#!
+'/'3+H!,')D!
!
getAllServers(): List<Servers>
&
-89B3798&B6<6H8:8<9&
Name Description Constraints
serverId 19,.'&%&,#!$%!'4,!E&#'3/0!+,#E,#! !
serverName B3'-3'+!'4,!./6,!$%!'4,!+-,)&%&,9!E&#'3/0!+,#E,#! [6-'&/50,!
ProfitBricks API Documentation v1.2
28 / 72
creationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+,#E,#!4/+!5,,.!)#,/',9! \300/50,!
lastModificationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+,#E,#!4/+!0/+'!5,,.!
6$9&%&,9!!
\300/50,!
provisioningState =,+)#&5,+!'4,!)3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+-,)&%&,9!
E&#'3/0!+,#E,#!?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!
=[a[F[=H![ZZBZA!
virtualMachineState =,+)#&5,+!'4,!)3##,.'!+,#E,#!+'/',!$%!'4,!+-,)&%&,9!
E&#'3/0!+,#E,#!?\B2FCF[H!ZW\\1\fH!(aB@p[=H!
"CW2[=H!2VWF=B]\H!2VWFBXXH!@ZC2V[=A!
cores C6$3.'!$%!)$#,+!/++&8.,9!'$!'4,!+-,)&%&,9!E&#'3/0!+,#E,#!
ram ZC_!?&.!_&(A!/++&8.,9!'$!'4,!+-,)&%&,9!E&#'3/0!+,#E,#!
internetAccess Z,'3#.+!FZW[!&%!+,#E,#!&+!)$..,)',9!'$!/!-350&)!aC\! [6-'&/50,!
ips a&+'+!/00!1"!/99#,++,+!/++&8.,9!'$!'4,!+,#E,#!
nics a&+'+!/00!\1@+!/++&8.,9!'$!'4,!+,#E,#D!2,,!/0+$!Get NIC! [6-'&/50,!
connectedStorages a&+'+!/00!+'$#/8,+!)$..,)',9!'$!'4,!+,#E,#H!&.)039&.8!'4,!
%$00$:&.8!-/#/6,.',#+M!
;!+'$#/8,19M!+'$#/8,!&9,.'&%&,#!
;!+'$#/8,\/6,M!./6,!$%!'4,!+'$#/8,!
;!+&J,M!+'$#/8,!+&J,!?&.!f&(A!
X$#!'4,+,!'4#,,!-/#/6,',#!+,,!/0+$!Create Storage!$#!Get Storage!
;!53+F7-,M!(3+!'7-,!'$!:4&)4!'4,!+'$#/8,!&+!)$..,)',9!
;!9,E&),\365,#M!9,E&),!.365,#!'4,!+'$#/8,!&+!
)$..,)',9!
X$#!'4,+,!':$!-/#/6,',#!+,,!/0+$!Connect Storage!
;!5$$'=,E&),M!/!%0/8H!&.9&)/'&.8!:4,'4,#!+,#E,#!&+!
5$$'&.8!%#$6!'4&+!+'$#/8,!$#!.$'!sFZW[NXCa2[t!
X$#!'4&+!-/#/6,',#!+,,!/0+$!Create Server!
[6-'&/50,!
availabilityZone o$.,!&.!:4&)4!'4,!+,#E,#!&+!0$)/',9!?CWFBH!oB\[hKH!
oB\[hLA!
!
romDrives a&+'+!/00!@=;ZB_!9#&E,+!/++&8.,9!'$!'4,!+,#E,#H!
&.)039&.8!'4,!-/#/6,',#+!$%!'4,!@=;ZB_N=Y=+!&6/8,H!
+3)4!/+M!
;!&6/8,19M!@=;ZB_N=Y=!&6/8,!&9,.'&%&,#!
;!&6/8,\/6,M!./6,!$%!'4,!@=;ZB_N=Y=!&6/8,!
;!5$$'=,E&),M!/!%0/8H!&.9&)/'&.8!:4,'4,#!+,#E,#!&+!
5$$'&.8!%#$6!'4&+!9#&E,!$#!.$'!sFZW[NXCa2[t!
2,,!/0+$!Add CD-ROM/DVD Drive To Server!
[6-'&/50,!
osType B2!'7-,!$%!'4,!+,#E,#!?]1\=B]2H!a1\WgH!BFV[ZH!
W\pB]\A!!
!
ProfitBricks API Documentation v1.2
29 / 72
&T&
*'+!"!%&
C!!f,'!C00!2,#E,#+!)$66/.9!#,'3#.+!'4,!+'/',!\B2FCF[!&%!'4,!-#$E&+&$.&.8!&+!+'&00!&.!-#$),++H!!$#!
?&.!)/+,!'4,!-#$E&+&$.&.8!-#$),++!:/+!+3)),++%30A!&%!&'d+!/'',6-'!'$!5$$'!%#$6!'4,!9,%&.,9!5$$'!
9,E&),!4/+!%/&0,9D!
/;J&A389&:;8&M8:&+8<?8<&53HH67A&34:B4:&73&.1&3<&*.)&B6<6H8:8<V&
1%!'4,!8,'!)$66/.9!$3'-3'+!.$!&.%$#6/'&$.!/5$3'!1"!/.9!\1@H!'4,.!'4,!-#$E&+&$.&.8!-#$),++!&+!
-#$5/507!.$'!%&.&+4,9!7,'D!F4,!+,#E,#!4/+!'$!5,!)$..,)',9!'$!'4,!.,':$#*!/.9!CYC1aC(a[!'$!#,'3#.!
'4,+,!-/#/6,',#+D!
Update Server
D1C"!%&+%-,%-&
W-9/',+!-/#/6,',#+!$%!/.!,G&+'&.8!E&#'3/0!+,#E,#!9,E&),D!!
!
updateServer(request : UpdateServerRequest)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
serverName Z,./6,+!'4,!'/#8,'!E&#'3/0!+,#E,#!
cores W-9/',+!'4,!/6$3.'!$%!)$#,+!$%!'4,!'/#8,'!E&#'3/0!+,#E,#!
ram W-9/',+!'4,!ZC_!6,6$#7!?&.!_&(A!$%!'4,!'/#8,'!E&#'3/0!
+,#E,#D!F4,!6&.&636!ZC_!+&J,!&+!L`^!_&(!
bootFromImageId =,%&.,+!/.!,G&+'&.8!@=;ZB_N=Y=!?12BA!&6/8,!1=!'$!5,!+,'!
/+!5$$'!9,E&),!$%!'4,!+,#E,#D!C!E&#'3/0!@=;ZB_N=Y=!9#&E,!
:&'4!'4,!6$3.',9!&6/8,!:&00!5,!)$..,)',9!'$!'4,!+,#E,#!
&6-0&)&'07D!2,,!/0+$!Add CD-ROM/DVD Drive To Server!
availabilityZone o$.,!&.!:4&)4!'4,!+,#E,#!&+!0$)/',9!?CWFBH!oB\[hKH!
oB\[hLA!
bootFromStorageId =,%&.,+!/.!,G&+'&.8!+'$#/8,!9,E&),!1=!'$!5,!+,'!/+!5$$'!
9,E&),!$%!'4,!+,#E,#D!F4,!+'$#/8,!:&00!5,!)$..,)',9!'$!'4,!
+,#E,#!&6-0&)&'07D!2,,!/0+$!Create Storage!
osType W-9/',+!B2!F7-,!$%!'4,!'/#8,'!+,#E,#!?]1\=B]2H!a1\WgH!
BFV[ZH!W\pB]\A!!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!3+,9!&.!'4,!E&#'3/0!+,#E,#!./6,!
ProfitBricks API Documentation v1.2
30 / 72
]#$.8!5$$'!&6/8,!'7-,!?,D8D!V==!&6/8,!&.+',/9!$%!@=;ZB_N=Y=!$#!E&),!
E,#+/A!
F$$!6/.7!5$$'!&6/8,+!?63+'!5,!,&'4,#!/!V==!BZ!/!@=;ZB_N=Y=!!&6/8,A!
1.E/0&9!ZC_!/.9N$#!)$#,+!
OVER_LIMIT_SETTING \365,#!$%!)$#,+!/.9N$#!ZC_!0&6&'!,G),,9,9D!2,,!/0+$!Resource Limits!%$#!6$#,!9,'/&0+!
RESOURCE_NOT_FOUND 2-,)&%&,9!2,#E,#H!5$$'!&6/8,!/.9N$#!+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Delete Server
C%$%!%&+%-,%-&
=,0,',+!/.!,G&+'&.8!Y&#'3/0!2,#E,#D!!
!
deleteServer(serverId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Reset Server
-%+%!&+%-,%-&
Z,+,'+!/.!,G&+'&.8!E&#'3/0!+,#E,#!?"B][Z!@m@a[AD!
2,#E,#!:&00!5,!%$#),%3007!-$:,#,9!$%%!/.9!#,+'/#',9!&66,9&/',07D!C.7!3.+/E,9!9/'/!6/7!5,!0$+'u!
(&00&.8!:&00!)$.'&.3,!!
&T&M<658I4F&-%#''!&
C!8#/),%30!#,5$$'!$%!/!+,#E,#!&+!.$'!-$++&50,!'4#$384!'4,!"#$%&'(#&)*+!C"1D!],!#,)$66,.9!'$!
/)),++!/.9!,G,)3',!'4,!)$66/.9!$.!'4,!E&#'3/0!+,#E,#!9&#,)'07D!!
!
resetServer(serverId : String)
!
ProfitBricks API Documentation v1.2
31 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Start Server
+!"-!&+%-,%-&
2'/#'+!/.!,G&+'&.8!E&#'3/0!+,#E,#!
2,#E,#!6/7!#,),&E,!.,:!-350&)!1"!/99#,++,+!&%!.,),++/#7! (&00&.8!:&00!)$.'&.3,!!!
startServer(serverId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Stop Server
+!'1&+%-,%-&
2'$-+!/.!,G&+'&.8!E&#'3/0!+,#E,#!%$#),%3007!?VCZ=!+'$-A!
2,#E,#!:&00!5,!%$#),%3007!-$:,#,9!$%%D!C.7!3.+/E,9!9/'/!6/7!5,!0$+'u! (&00&.8!%$#!'4&+!+,#E,#!:&00!5,!+'$--,9! ]4,.!#,+'/#'&.8!'4,!+,#E,#!/!.,:!-350&)!1"!8,'+!/++&8.,9H!/0',#./'&E,07H!7$3!)/.!#,+,#E,!1"!/99#,++,+H!+,,!#,+,#E/'&$.!$%!-350&)!1"!50$)*+!
!
ProfitBricks API Documentation v1.2
32 / 72
&T&M<658I4F&+0D!C'/*&
C!8#/),%30!+'$-!$%!/!+,#E,#!&+!.$'!-$++&50,!'4#$384!'4,!"#$%&'(#&)*+!C"1D!],!#,)$66,.9!'$!/)),++!
/.9!,G,)3',!'4,!)$66/.9!$.!'4,!E&#'3/0!+,#E,#!9&#,)'07D!B.),!'4,!+,#E,#!:/+!+43'9$:.!7$3!+'&00!
)/.!3+,!'4,!U+'$-2,#E,#U!6,'4$9!'4/'!:&00!+'$-!5&00&.8D!
!!
stopServer(serverId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Storage Operations
+!'-"M%&'1%-"!.'*+&!
.7A8Q=&
/0"*#"$4#&0*;"&
!"#$4#&0*;"&
!"#$5..$4#&0*;",&
/&++")#$4#&0*;"&
-',)&++")#$4#&0*;"&
678*#"$4#&0*;"&
-"."#"$4#&0*;"&
Create Storage
ProfitBricks API Documentation v1.2
33 / 72
)-%"!%&+!'-"M%&
@#,/',+!/!E&#'3/0!+'$#/8,!:&'4&.!/.!,G&+'&.8!E&#'3/0!9/'/!),.',#D!C99&'&$./0!-/#/6,',#+!)/.!5,!
+-,)&%&,9H!,D8D!%$#!/++&8.&.8!/!V==!&6/8,!'$!'4,!+'$#/8,D!
!
createStorage(request : CreateStorageRequest): CreateStorageResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
size 2'$#/8,!+&J,!?&.!f&(A! m,+!
dataCenterId =,%&.,+!'4,!9/'/!),.',#!:4,#,&.!'4,!+'$#/8,!&+!
'$!5,!)#,/',9D!1%!0,%'!,6-'7H!'4,!+'$#/8,!:&00!5,!
)#,/',9!&.!/!.,:!9/'/!),.',#!
storageName \/6,!$%!'4,!+'$#/8,!'$!5,!)#,/',9!
mountImageId 2-,)&%&,+!'4,!V==!&6/8,!'$!5,!/++&8.,9!'$!'4,!
+'$#/8,!57!&'+!1=!!
profitBricksImagePassword 2,'+!'4,!Y_!&6/8,!#$$'!0$8&.!-/++:$#9!'$!'4,!
+-,)&%&,9!E/03,D!B.07!+3--$#',9!%$#!8,.,#&)!
"#$%&'5#&)*+!V==!&6/8,+D!W+,#!&6/8,+!/#,!
,G-,)',9!'$!5,!-#,)$.%&83#,9!:&'4!/!-/++:$#9D!
1%!.$!-/++:$#9!&+!+3--0&,9H!$.,!&+!/3'$6/'&)/007!
)#,/',9D!"0,/+,!+,,!,##$#!)$9,+!%$#!-/++:$#9!
+7.'/G!#30,+D!
&T& .HB3<:67:&&F4,!&6/8,!:&00!5,!)#,/',9!/+!/!-/#'&'&$.!&.!'4,!+'$#/8,!9,E&),D!F4,!+&J,!$%!'4,!E&#'3/0!+'$#/8,!
&6/8,!63+'!5,!+6/00,#!$#!,S3/0!'4,!+'$#/8,!+&J,D!m$3!)/.!&.)#,/+,!'4,!+&J,!$%!'4,!+'$#/8,!&%!
.,),++/#7D!2,,!/0+$!Update Storage!
!
-89B3798&B6<6H8:8<9&&
Name Description
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!&.!'4,!E&#'3/0!+'$#/8,!./6,!
1.E/0&9!+'$#/8,!+&J,!?63+'!5,!n!K!f&(A!
16/8,!/.9!+'$#/8,!/#,!.$'!0$)/',9!&.!'4,!+/6,!#,8&$.!
"/++:$#9!&+!+,'!%$#!/!.$.;"#$%&5#&)*+!$#!"#$%&'5#&)*+;.$.;V==!&6/8,!
OVER_LIMIT_SETTING 2'$#/8,!+&J,!,G),,9+!0&6&'!
ProfitBricks API Documentation v1.2
34 / 72
RESOURCE_NOT_FOUND 2-,)&%&,9!16/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
PASSWORD_SYNTAX_ERROR f&E,.!-/++:$#9!9$,+!.$'!/5&9,!'$!-/++:$#9!+7.'/G!#30,+D!"0,/+,!+,,!
,##$#!6,++/8,!%$#!6$#,!9,'/&0+D!C+!$%!:#&'&.8H!-/++:$#9!63+'!5,!
5,':,,.!Q!/.9!`O!)4/#/)',#+H!$.07!/;JH!C;oH!O;b!:&'4$3'!!)4/#/)',#+!
&H!1H!0H!$H!BH!:H!]H!7H!mH!JH!o!/.9!KH!O!
Get Storage
M%!&+!'-"M%&
Z,'3#.+!&.%$#6/'&$.!/5$3'!/!E&#'3/0!+'$#/8,d+!)$.%&83#/'&$.!/.9!-#$E&+&$.&.8!+'/',D!
!
getStorage(storageId : String): Storage
!
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,! m,+!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,! !
storageName B3'-3'+!'4,!./6,!$%!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,! [6-'&/50,!
creationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!4/+!5,,.!)#,/',9! \300/50,!
lastModificationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!4/+!0/+'!5,,.!
6$9&%&,9!!
\300/50,!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!
?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!
!
size 2&J,!$%!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!?&.!f&(A! !
serverIds a&+'+!'4,!+,#E,#!)$..,)',9!'$!'4,!+'$#/8,!57!1=D!2,,!/0+$!
Get Server![6-'&/50,!
mountImage B3'-3'+!&.%$#6/'&$.!/5$3'!'4,!&6/8,!/++&8.,9!'$!'4,!
+'$#/8,H!+3)4!/+!&6/8,!1=!/.9!&6/8,!./6,D!2,,!/0+$!Get Image!
\300/50,!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED F4,!+'$#/8,!4/+!5,,.!9,0,',9!?57!'4,!3+,#A!!
RESOURCE_NOT_FOUND 2-,)&%&,9!+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
ProfitBricks API Documentation v1.2
35 / 72
et All Storages
M%!&"$$&+!'-"M%+&
Z,'3#.+!&.%$#6/'&$.!/5$3'!/00!E&#'3/0!+'$#/8,H!+3)4!/+!)$.%&83#/'&$.!/.9!-#$E&+&$.&.8!+'/',D!
!
getAllStorages(): List<Storages>
-89B3798&B6<6H8:8<9&&
Name Description Constraints
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,! !
storageName B3'-3'+!'4,!./6,!$%!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,! [6-'&/50,!
creationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!4/+!5,,.!)#,/',9! \300/50,!
lastModificationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!4/+!0/+'!5,,.!
6$9&%&,9!!
\300/50,!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!
?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!
!
size 2&J,!$%!'4,!+-,)&%&,9!E&#'3/0!+'$#/8,!?&.!f&(A! !
serverId a&+'+!'4,!+,#E,#!)$..,)',9!'$!'4,!+'$#/8,!57!1=D!2,,!/0+$!
Get Server![6-'&/50,!
mountImage B3'-3'+!&.%$#6/'&$.!/5$3'!'4,!&6/8,!/++&8.,9!'$!'4,!
+'$#/8,H!+3)4!/+!&6/8,!1=!/.9!&6/8,!./6,D!2,,!/0+$!Get Image!
\300/50,!
Connect Storage
)'**%)!&+!'-"M%&!
@$..,)'+!/!E&#'3/0!+'$#/8,!9,E&),!'$!/.!,G&+'&.8!+,#E,#D!
!
connectStorageToServer(request : ConnectStorageRequest)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,!'$!5,!)$..,)',9! m,+!
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
busType (3+!'7-,!'$!:4&)4!'4,!+'$#/8,!:&00!5,!)$..,)',9!
=,%/30'!F7-,!&+!Y1ZF1B!
F7-,!)/.!5,!1=[!$#!Y1ZF1B!?(3+F7-,!2@21!:&00!5,!
+3--$#',9!&.!'4,!%3'3#,A!
!
deviceNumber =,%&.,+!'4,!9,E&),!.365,#!$%!'4,!E&#'3/0!+'$#/8,D!1%!.$!
9,E&),!.365,#!&+!+,'H!/!9,E&),!.365,#!:&00!5,!/3'$6/'&)/007!
ProfitBricks API Documentation v1.2
36 / 72
/++&8.,9!!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 2-,)&%&,9!+'$#/8,!/.9!+,#E,#!/#,!.$'!0$)/',9!:&'4&.!'4,!+/6,!9/'/!),.',#!
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#N+'$#/8,!9$,+!.$'!,G&+'!
OVER_LIMIT_SETTING 2'$#/8,!)$..,)'&$.+!0&6&'!,G),,9,9!?6/GD!Q!-,#!E&#'3/0!+,#E,#A!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#N+'$#/8,!
Disconnect Storage
C.+)'**%)!&+!'-"M%&
=&+)$..,)'+!/!E&#'3/0!+'$#/8,!9,E&),!%#$6!/!)$..,)',9!+,#E,#D!
!
disconnectStorageFromServer(storageId : String, serverId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!)$..,)',9!E&#'3/0!+'$#/8,! m,+!
serverId 19,.'&%&,#!$%!'4,!)$..,)',9!E&#'3/0!+,#E,#! m,+!
%<<3<&)3A89&&
Code Description
PROVISIONING_NO_CHANGES 2'$#/8,!&+!.$'!)$..,)',9!'$!'4,!+-,)&%&,9!+,#E,#!
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#N+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#N+'$#/8,!
Update Storage
D1C"!%&+!'-"M%&!
W-9/',+!-/#/6,',#+!$%!/.!,G&+'&.8!E&#'3/0!+'$#/8,!9,E&),D!1'!&+!-$++&50,!'$!&.)#,/+,!'4,!
+'$#/8,!+&J,!:&'4$3'!#,5$$'!$%!/.!/0#,/97!-#$E&+&$.,9!+'$#/8,D!F4,!/99&'&$./0!)/-/)&'7!&+!.$'!
/99,9!'$!/.7!-/#'&'&$.D!m$3!4/E,!'$!-/#'&'&$.!'4,!+'$#/8,!/%',#:/#9+D!Y&),!E,#+/H!&'!&+!.$'!
-$++&50,!'$!9,)#,/+,!'4,!+'$#/8,!+&J,!$%!/.!/0#,/97!-#$E&+&$.,9!+'$#/8,D!
!
updateStorage(request : UpdateStorageRequest)
!
ProfitBricks API Documentation v1.2
37 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+'$#/8,! m,+!
storageName Z,./6,+!'4,!'/#8,'!E&#'3/0!+'$#/8,!
size W-9/',+!'4,!+&J,!$%!'4,!+'$#/8,!?&.!f&(A!
mountImageId 2-,)&%&,+!'4,!V==!&6/8,!'$!5,!/++&8.,9!'$!'4,!+'$#/8,!57!
&'+!1=!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!&.!'4,!E&#'3/0!+'$#/8,+!./6,!
1.E/0&9!+'$#/8,!+&J,!?63+'!5,!n!K!f&(A!
OVER_LIMIT_SETTING 2'$#/8,!+&J,!,G),,9+!0&6&'!
RESOURCE_NOT_FOUND 2-,)&%&,9!+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
Delete Storage
C%$%!%&+!'-"M%&
=,0,',+!/.!,G&+'&.8!E&#'3/0!+'$#/8,!9,E&),D!!
!
deleteStorage(storageId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+'$#/8,! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
Snapshot Operations
ProfitBricks API Documentation v1.2
38 / 72
+*"1+0'!&'1%-"!.'*+&!
.7A8Q=&
/0"*#"$4+*7,<&#&
!"#$4+*7,<&#&
!"#$5..$4+*7,<&#,&
678*#"$4+*7,<&#&
-"."#"$4+*7,<&#&
:&..1*)=$4+*7,<&# Create Snapshot
)-%"!%&+*"1+0'!&
@#,/',+!/!+./-+4$'!$%!/.!,G&+'&.8!+'$#/8,!9,E&),D!F4,!+&J,!$%!'4,!+./-+4$'!:&00!5,!'4,!+/6,!
/+!'4,!+&J,!$%!'4,!+'$#/8,!&'!:/+!'/*,.!%#$6!&.9,-,.9,.'!$%!4$:!63)4!$%!&'!&+!&.!3+,D!C.7!
+./-+4$'!:&00!5,!)4/#8,9!'$!7$3#!/))$3.'!/.9!5&00,9!0&*,!/.!V=!+'$#/8,!$%!'4,!+/6,!+&J,D!
AttentionM!C!+./-+4$'!$.07!&.)039,+!'4,!)$.',.'+!$%!'4,!+'$#/8,!53'!.$'!'4,!+'/',!$%!'4,!Y_!)$..,)',9!'$!&'D!
!
createSnapshot(request : CreateSnapshotRequest): CreateSnapshotResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,!%$#!:4&)4!/!
+./-+4$'!+4/00!5,!)#,/',9!
m,+!
snapshotName \/6,!$%!'4,!+./-+4$'!'$!5,!)#,/',9!
description C99&'&$./0!%&,09!'$!-#$E&9,!)3+'$6&J,9!
&.%$#6/'&$.!/5$3'!'4,!9/'/!&.!'4&+!+./-+4$'!
-89B3798&B6<6H8:8<9&&
Name Description
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'!
&
ProfitBricks API Documentation v1.2
39 / 72
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!2'$#/8,1=!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
Get Snapshot
M%!&+*"1+0'!&
Z,'3#.+!&.%$#6/'&$.!/5$3'!/!-/#'&)30/#!2./-+4$'!
!
getSnapshot(snapshotId : String): Snapshot
!
-8R489:&B6<6H8:8<9&&
Name Description Required
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'! m,+!
-89B3798&B6<6H8:8<9&&
Name Description
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'!
description ',G'!9/'/!'4/'!)/.!-#$E&9,!/99&'&$./0!9/'/!/5$3'!/!+./-+4$'!
snapshotName ./6,!$%!'4,!+./-+4$'!
snapshotSize +&J,!$%!'4,!+./-+4$'!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+./-+4$'!?1\C@F1Y[H!1\"ZB@[22H!
CYC1aC(a[H!=[a[F[=H![ZZBZA!
bootable %0/8!'$!&9,.'&%7!5$$'!)/-/5&0&'&,+!$%!/!+./-+4$'T!!
%0/8!$%!'7-,!5$$0,/.!
osType %0/8!$%!)3##,.'07!+,'!B2!'7-,!$%!'4,!+./-+4$'!?]1\=B]2H!a1\WgH!
BFV[ZH!W\p\B]\A!
cpuHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!@"WT!%0/8!$%!'7-,!5$$0,/.!
ramHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!ZC_T!%0/8!$%!'7-,!5$$0,/.!
nicHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!\1@T!%0/8!$%!'7-,!5$$0,/.!
nicHotUnPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'3.-038!\1@T!%0/8!$%!'7-,!5$$0,/.!
creationTimestamp F&6,!:4,.!'4,!+-,)&%&,9!+./-+4$'!4/+!5,,.!)#,/',9!
modificationTimestamp F&6,!:4,.!'4,!+-,)&%&,9!+./-+4$'!4/+!0/+'!5,,.!6$9&%&,9!
region ./6,!$%!#,8&$.!&.!:4&)4!'4,!+./-+4$'!&+!/E/&0/50,T!&'!)/..$'!5,!3+,9!
&.!/.7!$'4,#!#,8&$.!'4/.!'4/'!
ProfitBricks API Documentation v1.2
40 / 72
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+./-+4$'!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+./-+4$'!
Get All Snapshots
M%!&"$$&+*"1+0'!+&
"#$E&9,+!/!0&+'!$%!/00!+./-+4$'+!/E/&0/50,!'$!'4&+!/))$3.'!
!
getAllSnapshots(): List<Snapshots>
!
-89B3798&B6<6H8:8<9&&
Name Description
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'!
description ',G'!9/'/!'4/'!)/.!-#$E&9,!/99&'&$./0!9/'/!/5$3'!/!+./-+4$'!
snapshotName ./6,!$%!'4,!+./-+4$'!
snapshotSize +&J,!$%!'4,!+./-+4$'!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+./-+4$'!?1\C@F1Y[H!1\"ZB@[22H!
CYC1aC(a[H!=[a[F[=H![ZZBZA!
bootable %0/8!'$!&9,.'&%7!5$$'!)/-/5&0&'&,+!$%!/!+./-+4$'T!!
%0/8!$%!'7-,!5$$0,/.!
osType %0/8!$%!)3##,.'07!+,'!B2!'7-,!$%!'4,!+./-+4$'!?]1\=B]2H!a1\WgH!
BFV[ZH!W\p\B]\A!
cpuHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!@"WT!%0/8!$%!'7-,!5$$0,/.!
ramHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!ZC_T!%0/8!$%!'7-,!5$$0,/.!
nicHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!\1@T!%0/8!$%!'7-,!5$$0,/.!
nicHotUnPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'3.-038!\1@T!%0/8!$%!'7-,!5$$0,/.!
creationTimestamp F&6,!:4,.!'4,!+-,)&%&,9!+./-+4$'!4/+!5,,.!)#,/',9!
modificationTimestamp F&6,!:4,.!'4,!+-,)&%&,9!+./-+4$'!4/+!0/+'!5,,.!6$9&%&,9!!
region ./6,!$%!#,8&$.!&.!:4&)4!'4,!+./-+4$'!&+!/E/&0/50,T!&'!)/..$'!5,!3+,9!
&.!/.7!$'4,#!#,8&$.!'4/.!'4/'!
Update Snapshot
D1C"!%&+*"1+0'!&
W-9/',+!6,'/!9/'/!$%!/!+./-+4$'D!F4&+!6,'/!9/'/!)/.!5,!#,0,E/.'!/+!'4,7!'#&88,#!$'4,#!
%,/'3#,+!0&*,!a&E,!Y,#'&)/0!2)/0&.8!$%!@"W!$#!ZC_D!
ProfitBricks API Documentation v1.2
41 / 72
!
updateSnapshot(request : updateSnapshotRequest): updateSnapshotResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'!'4/'!+4/00!8,'!3-9/',9! 7,+!
description ',G'!%&,09!'$!/99!/99&'&$./0!&.%$#6/'&$.!?,D8D!%$#!
9,'/&0+!/5$3'!'&6,!$#!#,/+$.!:47!+./-+4$'!:/+!
)#,/',9A!
!
snapshotName ./6,!$%!+./-+4$'! !
bootable %0/8!$%!'7-,!5$$0,/.! !
osType %0/8!'$!+-,)&%7!B2!'7-,T!#,0,E/.'!%$#!0&),.+,!
/))$3.'&.8!&.!)/+,!+./-+4$'!8,'+!#,9,-0$7,9!$.!
%3#'4,#!E&#'3/0!+'$#/8,!&.+'/.),+!?]1\=B]2H!
a1\WgH!BFV[ZH!W\p\B]\A!
!
cpuHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!@"WT!
%0/8!$%!'7-,!5$$0,/.!
!
ramHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!ZC_T!
%0/8!$%!'7-,!5$$0,/.!
!
nicHotPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!\1@T!
%0/8!$%!'7-,!5$$0,/.!
!
nicHotUnPlug +./-+4$'!)$.'/&.+!)/-/5&0&'&,+!'$!4$'3.-038!\1@T!
%0/8!$%!'7-,!5$$0,/.!
!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!2'$#/8,1=!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
Delete Snapshot
C%$%!%&+*"1+0'!&
=,0,',+!/!+./-+4$'D!"0,/+,!5,!/:/#,!'4/'!9,0,',9!+./-+4$'+!/.9!#,0/',9!9/'/!&.!'4&+!+./-+4$'!
)/..$'!5,!#,)$E,#,9!/.76$#,D!
!
deleteSnapshot(request : DeleteSnapshotRequest): DeleteSnapshotResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'!'4/'!+4/00!8,'!9,0,',9! m,+!
ProfitBricks API Documentation v1.2
42 / 72
!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+./-+4$'!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Rollback Snapshot
-'$$#")W&+*"1+0'!&W+&.8!'4,!#$005/)*!$-'&$.!7$3!6/7!#,9,-0$7!'4,!+./-+4$'',9!+'/',!$.!/!+'$#/8,D!
AttentionM!F4,!)3##,.'!+'/',!$%!'4,!+'$#/8,!:&00!5,!0$+'!3.0,++!7$3!)#,/',!/.$'4,#!+./-+4$'!5,%$#,!#$00&.8!5/)*D!
!
rollbackSnapshot(request : rollbackSnapshotRequest): rollbackSnapshotResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
storageId 19,.'&%&,#!$%!'4,!E&#'3/0!+'$#/8,!/+!'/#8,'!%$#!'4,!
+./-+4$'!
m,+!
snapshotId 19,.'&%&,#!$%!'4,!+./-+4$'!'4/'!+4/00!8,'!
9,-0$7,9!$.!/!E&#'3/0!+'$#/8,!
m,+!
!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 2&J,!$%!+./-+4$'!&+!5&88,#!'4/.!+&J,!$%!+'$#/8,!
RESOURCE_NOT_FOUND 2-,)&%&,9!+./-+4$'!$#!+-,)&%&,9!+'$#/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+'$#/8,!
Load Balancer Operations
$'"C&#"$"*)%-&'1%-"!.'*+&!
C!a$/9!(/0/.),#!)$..,)',9!'$!/!aC\!:&00!.$'!9&+'#&53',!'#/%%&)!'$!/.7!+,#E,#H!3.'&0!&'!&+!+-,)&%&,9!'$!9$!+$D!
1.!'4,!)3##,.'!E,#+&$.H!/!a$/9!(/0/.),#!)/..$'!9&+'#&53',!'#/%%&)!/)#$++!630'&-0,!9/'/!),.',#+!$#!aC\+D!
a$/9!(/0/.),#!/.9!+,#E,#+!63+'!/0:/7+!5,!&.!'4,!+/6,!aC\D!2,,!/0+$!Register Servers On Load Balancer!
ProfitBricks API Documentation v1.2
43 / 72
.7A8Q&
/0"*#"$>&*8$?*.*+)"0&
!"#$>&*8$?*.*+)"0&
!"#$5..$>&*8$?*.*+)"0&
678*#"$>&*8$?*.*+)"0&
:";',#"0$4"09"0,$@+$>&*8$?*.*+)"0&
-"0";',#"0$4"09"0,$>&*8$?*.*+)"0&
5)#'9*#"A-"*)#'9*#"$>&*8$?*.*+)"0$
-"."#"$>&*8$?*.*+)"0$
Create Load Balancer
)-%"!%&$'"C&#"$"*)%-&!
@#,/',+!/!E&#'3/0!a$/9!(/0/.),#!:&'4&.!/.!,G&+'&.8!E&#'3/0!9/'/!),.',#D!
!
createLoadBalancer(request : CreateLbRequest) : CreateLbResponse
!
&T& *3:8&a$/9!(/0/.),#!/.9!'4,!5/0/.),9!\1@!$%!'4,!+,#E,#!+4/#,!$.,!+&.80,!1"!/99#,++D!!
-8R489:&B6<6H8:8<9&&
Name Description Required
dataCenterId 9/'/!),.',#!1=!:4,#,&.!'4,!0$/9!5/0/.),#!&+!'$!5,!
)#,/',9!
m,+!
loadBalancerName \/6,!$%!'4,!0$/9!5/0/.),#!'$!5,!)#,/',9!
loadBalancerAlgorithm 0$/9!5/0/.),#!/08$#&'46D!ZBW\=hZB(1\!&+!9,%/30'!/.9!
'4,!$.07!+3--$#',9!/08$#&'46!/'!'4,!6$6,.'!!
ip C!=V@"!1"!/99#,++!&+!5,&.8!/++&8.,9!'$!'4,!0$/9!
5/0/.),#!/3'$6/'&)/007!57!"#$%&'(#&)*+D!C!-#&E/',!1"!)/.!
5,!9,%&.,9!57!'4,!3+,#D!C99&'&$./0H!-350&)!1"+!)/.!5,!
#,+,#E,9!/.9!/++&8.,9!'$!'4,!0$/9!5/0/.),#!6/.3/007D!
ProfitBricks API Documentation v1.2
44 / 72
2,,!/0+$!Reserve Public IP Block!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!1=!n!O!
1%!'4,!+-,)&%&,9!aC\!1=!9$,+!.$'!,G&+'!$#!&%!aC\!1=!&+!
.$'!+-,)&%&,9H!/!.,:!aC\!:&'4!'4,!8&E,.!1=!N!:&'4!/!
.,G'!/E/&0/50,!1=!+'/#'&.8!%#$6!K!:&00!5,!)#,/',9!
#,+-,)'&E,07!
serverIds 19,.'&%&,#!$%!/00!+,#E,#+H!'$!:4&)4!'4,!0$/9!5/0/.),#!&+!
8$&.8!'$!9&+'#&53',!'#/%%&)D!2,#E,#+!)/.!/0+$!5,!
#,8&+',#,9!'$!0$/9!5/0/.),#!0/',#!D!2,,!/0+$!Register Servers On Load Balancer!
-89B3798&B6<6H8:8<9&&
Name Description
loadBalancerId 19,.'&%&,#!$%!'4,!0$/9!5/0/.),#!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!&.!0$/9!5/0/.),#!./6,!
1.E/0&9!-#&E/',!1"!/99#,++!
a$/9!5/0/.),#!/.9!'/#8,'!+,#E,#+!/#,!.$'!0$)/',9!&.!'4,!+/6,!9/'/!
),.',#!1.E/0&9!aC\!1=! !O!
Z,+,#E,9!1"!/.9!0$/9!5/0/.),#!$%!'4,!9/'/!),.',#!/#,!0$)/',9!&.!
9&%%,#,.'!#,8&$.+!
RESOURCE_NOT_FOUND 2-,)&%&,9!9/'/!),.',#!/.9N$#!'/#8,'!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!9/'/!),.',#!/.9N$#!'/#8,'!+,#E,#!!!
W+,#!&+!.$'!/3'4$#&J,9!'$!3+,!'4,!)3+'$6,#!#,+,#E,9!1"!/99#,++!!
Get Load Balancer
M%!&$'"C&#"$"*)%-&Z,'3#.+!&.%$#6/'&$.!/5$3'!/!E&#'3/0!0$/9!5/0/.),#D!!
getLoadBalancer(loadBalancerId : String) : LoadBalancer
!
-8R489:&B6<6H8:8<9&&
Name Description loadBalancerId 19,.'&%&,#!$%!'4,!0$/9!5/0/.),#! m,+!
&
&
ProfitBricks API Documentation v1.2
45 / 72
-89B3798&B6<6H8:8<9&&
Name Description Constraints
loadBalancerId 19,.'&%&,#!$%!'4,!0$/9!5/0/.),#!
creationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!0$/9!5/0/.),#!4/+!5,,.!
)#,/',9!
\300/50,!
lastModificationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!0$/9!5/0/.),#!4/+!0/+'!
5,,.!6$9&%&,9!
\300/50,!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+-,)&%&,9!E&#'3/0!
+'$#/8,!?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!
=[a[F[=H![ZZBZA!
loadBalancerName B3'-3'+!'4,!./6,!$%!'4,!0$/9!5/0/.),#!
loadBalancerAlgorithm B3'-3'+!'4,!0$/9!5/0/.),#!/08$#&'46D!ZBW\=hZB(1\!&+!
'4,!9,%/30'!/.9!)3##,.'07!'4,!$.07!+3--$#',9!/08$#&'46!!
ip 1"!/99#,++!/++&8.,9!'$!'4,!0$/9!5/0/.),#!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!1=!'$!:4&)4!'4,!0$/9!
5/0/.),#!/.9!'4,!5/0/.),9!+,#E,#+!/#,!)$..,)',9!
balancedServers a&+'!/00!+,#E,#+!#,8&+',#,9!'$!'4,!0$/9!5/0/.),#H!
&.)039&.8!'4,&#!&9,.'&%&,#!?+,#E,#19AH!./6,!
?+,#E,#\/6,AH!&9,.'&%&,#!$%!'4,!5/0/.),9!\&)!
?5/0/.),9\&)19A!'4#$384!:4&)4!'4,!0$/9!5/0/.),#!
%$#:/#9+!'#/%%&)!'$!'4,!+,#E,#H!/.9!&%!0$/9!5/0/.)&.8!&+!
/)'&E/',!$.!'4&+!+,#E,#!?/)'&E/',A!
[6-'&/50,!
firewall X&#,:/00!)#,/',9!$.!'4,!0$/9!5/0/.),#D!2,,!/0+$ Add Firewall Rules
\300/50,!
internetAccess Z,'3#.+!FZW[!&%!0$/9!5/0/.),#!&+!)$..,)',9!'$!/!-350&)!
aC\!
!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED F4,!0$/9!5/0/.),#!4/+!5,,.!9,0,',9!
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!0$/9!5/0/.),#!
Get All Load Balancer
M%!&"$$&$'"C&#"$"*)%-+&Z,'3#.+!&.%$#6/'&$.!/5$3'!/00!E&#'3/0!0$/9!5/0/.),#D!!
getAllLoadBalancers(): List<loadbalancers>
!
&
ProfitBricks API Documentation v1.2
46 / 72
-8R489:&B6<6H8:8<9&&
*378&
&
-89B3798&B6<6H8:8<9&&
Name Description Constraints
loadBalancerId 19,.'&%&,#!$%!'4,!0$/9!5/0/.),#!
creationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!0$/9!5/0/.),#!4/+!5,,.!
)#,/',9!
\300/50,!
lastModificationTime F&6,!:4,.!'4,!+-,)&%&,9!E&#'3/0!0$/9!5/0/.),#!4/+!0/+'!
5,,.!6$9&%&,9!
\300/50,!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!+-,)&%&,9!E&#'3/0!
+'$#/8,!?1\C@F1Y[H!1\"ZB@[22H!CYC1aC(a[H!
=[a[F[=H![ZZBZA!
loadBalancerName B3'-3'+!'4,!./6,!$%!'4,!0$/9!5/0/.),#!
loadBalancerAlgorithm B3'-3'+!'4,!0$/9!5/0/.),#!/08$#&'46D!ZBW\=hZB(1\!&+!
'4,!9,%/30'!/.9!)3##,.'07!'4,!$.07!+3--$#',9!/08$#&'46!!
ip 1"!/99#,++!/++&8.,9!'$!'4,!0$/9!5/0/.),#!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!1=!'$!:4&)4!'4,!0$/9!
5/0/.),#!/.9!'4,!5/0/.),9!+,#E,#+!/#,!)$..,)',9!
balancedServers a&+'!/00!+,#E,#+!#,8&+',#,9!'$!'4,!0$/9!5/0/.),#H!
&.)039&.8!'4,&#!&9,.'&%&,#!?+,#E,#19AH!./6,!
?+,#E,#\/6,AH!&9,.'&%&,#!$%!'4,!5/0/.),9!\&)!
?5/0/.),9\&)19A!'4#$384!:4&)4!'4,!0$/9!5/0/.),#!
%$#:/#9+!'#/%%&)!'$!'4,!+,#E,#H!/.9!&%!0$/9!5/0/.)&.8!&+!
/)'&E/',!$.!'4&+!+,#E,#!?/)'&E/',A!
[6-'&/50,!
firewall X&#,:/00!)#,/',9!$.!'4,!0$/9!5/0/.),#D!2,,!/0+$ Add Firewall Rules
\300/50,!
internetAccess Z,'3#.+!FZW[!&%!0$/9!5/0/.),#!&+!)$..,)',9!'$!/!-350&)!
aC\!
!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED F4,!0$/9!5/0/.),#!4/+!5,,.!9,0,',9!
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!0$/9!5/0/.),#!
ProfitBricks API Documentation v1.2
47 / 72
Update Load Balancer
D1C"!%&$'"C&#"$"*)%-&@4/.8,+!'4,!+,''&.8+!$%!/.!,G&+'&.8!E&#'3/0!0$/9!5/0/.),#D!!
updateLoadBalancer(request : UpdateLbRequest)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
loadBalancerId 19,.'&%&,#!$%!'4,!0$/9!5/0/.),#! m,+!
loadBalancerName Z,./6,+!'4,!'/#8,'!E&#'3/0!0$/9!5/0/.),#!
loadBalancerAlgorithm 2,'+!'4,!0$/9!5/0/.),#!/08$#&'46D!ZBW\=hZB(1\!&+!'4,!9,%/30'!/.9!)3##,.'07!'4,!$.07!+3--$#',9!/08$#&'46!!
ip W-9/',+!'4,!1"!/99#,++!$%!'4,!0$/9!5/0/.),#!:&'4!'4,!
+-,)&%&,9!1"D!C00!+,#E,#+!)$..,)',9!'$!'4,!0$/9!5/0/.),#!
:&00!4/E,!'4,&#!-#&6/#7!1"!/99#,++!3-9/',9!:&'4!'4,!
+/6,!1"!/99#,++!$%!'4,!0$/9!5/0/.),#!&6-0&)&'07!
C99&'&$./0!)3+'$6,#!#,+,#E,9!1"!/99#,++,+H!:4&)4!4/E,!
5,,.!/99,9!'$!'4,!2,#E,#d+!\1@H!#,6/&.!3.)4/.8,9!!
2,'!&-!'$!,6-'7H!'$!#,+,'!'4,!1"!$%!0$/9!5/0/.),#!:&'4!/!
"#$%&'(#&)*+!/++&8.,9!1"!/99#,++D!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 1.E/0&9!)4/#/)',#+!3+,9!&.!'4,!E&#'3/0!0$/9!5/0/.),#!./6,!
1.E/0&9!-#&E/',!1"!/99#,++!
Z,+,#E,9!1"!/.9!0$/9!5/0/.),#!$%!'4,!9/'/!),.',#!/#,!0$)/',9!&.!
9&%%,#,.'!#,8&$.+!
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!0$/9!5/0/.),#!
Register Servers On Load Balancer
-%M.+!%-&+%-,%-+&'*&$'"C&#"$"*)%-&C99+!.,:!+,#E,#+!'$!/.!,G&+'&.8!a$/9!(/0/.),#!:&'4&.!'4,!#,+-,)'&E,!aC\D!1%!'4,!+,#E,#!&+!.$'!7,'!/!
6,65,#!$%!'4,!aC\H!/!.,:!\1@!&+!)#,/',9H!)$..,)',9!'$!'4,!aC\!/.9!#,8&+',#,9!:&'4!'4,!a$/9!(/0/.),#D!
F4,!0$/9!5/0/.),#!:&00!9&+'#&53',!'#/%%&)!'$!'4,!+,#E,#!'4#$384!'4&+!5/0/.),9!\1@D!1%!'4,!+,#E,#!&+!/0#,/97!/!
6,65,#!$%!'4,!aC\H!'4,!/--#$-#&/',!\1@!&+!3+,9!/+!5/0/.),9!\1@D!C!+,#E,#!)/.!5,!#,8&+',#,9!'$!6$#,!
'4/.!$.,!a$/9!(/0/.),#D!
registerServersOnLoadBalancer (serverIds : List<String>, loadBalancerId : String) : RegisterLbServerResponse
ProfitBricks API Documentation v1.2
48 / 72
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverIds 19,.'&%&,#!$%!+,#E,#+!'$!5,!#,8&+',#,9!:&'4!'/#8,'!0$/9!
5/0/.),#!
m,+!
loadBalancerId 19,.'&%&,#!$%!'/#8,'!0$/9!5/0/.),#! m,+!
-89B3798&B6<6H8:8<9&&
Name Description loadBalancerId 19,.'&%&,#!$%!'4,!'/#8,'!0$/9!5/0/.),#!
lanId 19,.'&%&,#!$%!'4,!aC\H!'$!:4&)4!0$/9!5/0/.),#!/.9!5/0/.),9!
+,#E,#+!/#,!)$..,)',9!
balancedServers a&+'+!/00!+,#E,#+!#,8&+',#,9!'$!'4,!0$/9!5/0/.),#H!&.)039&.8!
'4,&#!&9,.'&%&,#!?+,#E,#19AH!./6,!?+,#E,#\/6,AH!&9,.'&%&,#!$%!
'4,!5/0/.),9!\&)!?5/0/.),9\&)19A!'4#$384!:4&)4!'4,!0$/9!
5/0/.),#!%$#:/#9+!'#/%%&)!'$!'4,!+,#E,#H!/.9!&%!0$/9!5/0/.)&.8!
&+!/)'&E/',!$.!'4&+!+,#E,#!?/)'&E/',A!
%<<3<&)3A89&&
Code Description
BAD_REQUEST a$/9!5/0/.),#!/.9!#,8&+',#,9!+,#E,#+!/#,!.$'!0$)/',9!:&'4&.!'4,!+/6,!9/'/!
),.',#!
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!N!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!0$/9!5/0/.),#!N!+,#E,#+!
W+,#!&+!.$'!/3'4$#&J,9!'$!3+,!'4,!)3+'$6,#!#,+,#E,9!1"!/99#,++!
Deregister Servers On Load Balancer
C%-%M.+!%-&+%-,%-+&'*&$'"C&#"$"*)%-&(7!9,#,8&+',#&.8!/!+,#E,#H!!'4,!+,#E,#!&+!5,&.8!#,6$E,9!%#$6!'4,!0$/9!5/0/.),#!53'!+'&00!#,6/&.+!
)$..,)',9!'$!'4,!+/6,!aC\D!F4,!-#&6/#7!1"!/99#,++!$%!'4,!\1@H!'4#$384!:4&)4!'4,!0$/9!5/0/.),#!
9&+'#&53',9!'#/%%&)!'$!'4,!+,#E,#!5,%$#,H!&+!#,+,'!/.9!#,-0/),9!57!/!"#$%&'(#&)*+!/++&8.,9!1"!/99#,++D!
deregisterServersOnLoadBalancer (serverIds: List<String>, loadBalancerId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverIds 19,.'&%&,#!$%!+,#E,#+!'$!5,!9,#,8&+',#,9!:&'4!'/#8,'!0$/9!
5/0/.),#!
m,+!
ProfitBricks API Documentation v1.2
49 / 72
loadBalancerId 19,.'&%&,#!$%!'/#8,'!0$/9!5/0/.),#! m,+!
%<<3<&)3A89&&
Code Description
PROVISIONING_NO_CHANGES \$!+,#E,#+!'$!9,#,8&+',#!%$3.9H!5,)/3+,!.$.,!$%!'4,6!4/E,!5,,.!#,8&+',#,9!'$!'4,!0$/9!5/0/.),#!5,%$#,!
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!N!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!0$/9!5/0/.),#!N!+,#E,#+!
Delete Load Balancer
C%$%!%&$'"C&#"$"*)%-&=,0,',+!/.!,G&+'&.8!0$/9!5/0/.),#D!!"#&6/#7!1"!/99#,++,+!$%!'4,!+,#E,#d+!-#,E&$3+07!5/0/.),9!\1@+!/#,!
#,+,'!/.9!#,-0/),9!:&'4!"#$%&'(#&)*+!/++&8.,9!1"!/99#,++D!1%!/!0$/9!5/0/.),#!4/+!5,,.!9,0,',9H!/00!+,#E,#+!
:&00!+'&00!5,!)$..,)',9!'$!'4,!+/6,!aC\!'4$384D!
deleteLoadBalancer(loadBalancerId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
loadBalancerId 19,.'&%&,#!$%!'/#8,'!0$/9!5/0/.),#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!0$/9!5/0/.),#!
Activate/Deactivate Load Balancing On Servers
")!.,"!%UC%")!.,"!%&$'"C&#"$"*).*M&'*&+%-,%-+&
XX&(%"!D-%&.+&C%1-%)."!%C&YY&!
F4&+!%,/'3#,!&+!.$'!+3--$#',9!/.7!0$.8,#D!1'!&+!.$'!-$++&50,!'$!/)'&E/',!$#!9,/)'&E/',!0$/9!5/0/.)&.8!$.!
+,#E,#+D!
1.!)/+,!7$3!,./50,!$#!9&+/50,!+,#E,#+!%#$6!0$/9!5/0/.)&.8!-0,/+,!3+,!'4,!%$00$:&.8!6,'4$9+M!
:";',#"0$4"09"0,$@+$>&*8$?*.*+)"0!
ProfitBricks API Documentation v1.2
50 / 72
-"0";',#"0$4"09"0,$>&*8$?*.*+)"0!!
$%M")2&(%"!D-%&C%+)-.1!.'*&
&[./50,+!$#!9&+/50,+!'4,!0$/9!5/0/.),#!'$!9&+'#&53',!'#/%%&)!'$!'4,!+-,)&%&,9!+,#E,#+D!
activateLoadBalancingOnServers(loadBalancerId : String, serverIds :
List<String>)
deactivateLoadBalancingOnServers(loadBalancerId : String, serverIds : List<String>)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
serverIds 19,.'&%&,#!$%!'/#8,'!+,#E,#+! m,+!
loadBalancerId 19,.'&%&,#!$%!'/#8,'!0$/9!5/0/.),#! m,+!
%<<3<&)3A89&&
Code Description
BAD_REQUEST 2,#E,#!4/+!.$'!5,,.!#,8&+',#,9!:&'4!0$/9!5/0/.),#!5,%$#,!
RESOURCE_NOT_FOUND 2-,)&%&,9!0$/9!5/0/.),#!N!+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!0$/9!5/0/.),#!N!+,#E,#+!
Firewall Operations
(.-%/"$$&'1%-"!.'*+&!
C00!%&#,:/00!#30,+!/#,!/)),-';#30,+D!C.!/)'&E,!%&#,:/00!:&00!$.07!/00$:!'#/%%&)!%$00$:&.8!'4,!3+,#!9,%&.,9!
#30,+D!C.!/)'&E,!%&#,:/00!:&'4!.$!/)),-';#30,+H!:&00!9#$-!/00!'#/%%&)D!C.!&./)'&E,!%&#,:/00!:&00!/00$:!/00!'#/%%&)D!
CZ"!-/)*,'+!/#,!/0:/7+!/)),-',9D!
1.)$6&.8!-/)*,'+!#,-0&,9!'$!$3'8$&.8!-/)*,'+!/#,!/0:/7+!/)),-',9D!
&T&.HB3<:67:&*3:@589&
\$!%&#,:/00!#30,+!+4$309!5,!-0/),9!5,':,,.!/!0$/9!5/0/.),#!/.9!&'+!0$/9!5/0/.),9!+,#E,#+D!
ProfitBricks API Documentation v1.2
51 / 72
.7A8Q&
588$B'0"C*..$:D.",&
!"#$B'0"C*..&
!"#$5..$B'0"C*..,&
:"E&9"$B'0"C*..$:D.",&
5)#'9*#"A-"*)#'9*#"$$B'0"C*..&
-"."#"$B'0"C*..&
Add Firewall Rules
"CC&(.-%/"$$&-D$%+&!'&*.)&!
C99+!/)),-';#30,+!'$!'4,!%&#,:/00!$%!/!8&E,.!\1@D!1%!.$!%&#,:/00!,G&+'+H!/!.,:!&./)'&E,!%&#,:/00!&+!)#,/',9D!
X&#,:/00+!)/.!5,!/)'&E/',9!N!9,/)'&E/',9T!/99&'&$./0!/)),-';#30,+!)/.!5,!/99,9!/.7'&6,D!
addFirewallRulesToNic(request : List<FirewallRuleRequest>, nicId : String) : Firewall
!
-8R489:&B6<6H8:8<9&&
Name Description Required
firewallRuleRequests =,%&.,+!/!+,'!$%!/)),-';#30,+!/--0&,9!%$#!'4,!'/#8,'!\1@D!
[/)4!#30,!&+!9,%&.,9!/+!%$00$:+!?vA!
m,+!
nicId 19,.'&%&,#!$%!'/#8,'!\1@! m,+!
KZL&(@<8O6FF&<4F8&<8R489:9&
Name Description Required
protocol 2,0,)'!/00$:,9!-#$'$)$0!?F@"H!W"=H!1@_"H!C\mAD!
=,%/30'!&+!C\m!
sourceMac B.07!'#/%%&)!$#&8&./',9!%#$6!'4,!#,+-,)'&E,!_C@!
/99#,++!&+!/00$:,9D!Y/0&9!%$#6/'M!
//M55M))M99M,,M%%D!a,%'!,6-'7!'$!/00$:!/00!+$3#),!
_C@!/99#,++!
sourceIp B.07!'#/%%&)!$#&8&./',9!%#$6!'4,!#,+-,)'&E,!1"Ee!
/99#,++!&+!/00$:,9D!a,/E,!,6-'7!'$!/00$:!/00!
+$3#),!1"+!
ProfitBricks API Documentation v1.2
52 / 72
targetIp 1.!)/+,!'4,!'/#8,'!\1@!4/+!630'&-0,!1"!/99#,++,+H!
$.07!'#/%%&)!9&#,)',9!'$!'4,!#,+-,)'&E,!1"!/99#,++!$%!
'4,!\1@!&+!/00$:,9D!a,%'!,6-'7!'$!/00$:!/00!'/#8,'!
1"+!
portRangeStart =,%&.,+!'4,!+'/#'!#/.8,!$%!'4,!/00$:,9!-$#'!?%#$6!K!
'$!^``PeA!&%!-#$'$)$0!F@"!$#!W="!&+!)4$+,.D!a,/E,!
-$#'Z/.8,2'/#'!/.9!-$#'Z/.8,[.9!,6-'7!'$!/00$:!
/00!-$#'+!
m,+!&%!
portRangeEnd!&+!
+-,)&%&,9!
portRangeEnd =,%&.,+!'4,!,.9!#/.8,!$%!'4,!/00$:,9!-$#'!?%#$6!K!
'$!^``PeA!&%!-#$'$)$0!F@"!$#!W="!&+!)4$+,.D!a,/E,!
-$#'Z/.8,2'/#'!/.9!-$#'Z/.8,[.9!,6-'7!'$!/00$:!
/00!-$#'+!
m,+!&%!
portRangeStart!
&+!+-,)&%&,9!
icmpType =,%&.,+!'4,!/00$:,9!'7-,!?%#$6!O!'$!L`eA!&%!
-#$'$)$0!1@_"!&+!)4$+,.D!a,/E,!,6-'7!'$!/00$:!/00!
'7-,+!
icmpCode =,%&.,+!'4,!/00$:,9!)$9,!?%#$6!O!'$!L`eA!&%!
-#$'$)$0!1@_"!&+!)4$+,.D!a,/E,!,6-'7!'$!/00$:!/00!
'7-,+!
firewallRuleId 19,.'&%&,#!?./6,A!$%!'4,!%&#,:/00!#30,!
&T&*3:8&
F$!5,!/50,!'$!9,%&.,!portRangeStart!/.9!portRangeEndH!,&'4,#!-#$'$)$0!F@"!$#!W="!63+'!5,!
)4$+,.D!!
-89B3798&B6<6H8:8<9&
Name Description Constraints
firewallId 19,.'&%&,#!$%!'4,!'/#8,'!%&#,:/00!
nicId 19,.'&%&,#!$%!'4,!\1@!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!%&#,:/00!?1\C@F1Y[H!
1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!
active X&#,:/00!&+!/)'&E,!sFZW[NXCa2[t!
firewallRules a&+'!/00!%&#,:/00!#30,+H!&.)039&.8!'4,&#!&9,.'&%&,#!
?%&#,:/00Z30,19AH!%&#,:/00Z30,\/6,H!-#$'$)$0H!+$3#),_/)H!
+$3#),1-H!'/#8,'1"H!-$#'Z/.8,2'/#'H!-$#'Z/.8,[.9H!
&)6-F7-,H!/.9!&)6-@$9,!
%<<3<&)3A89&&
Code Description
BAD_REQUEST "#$'$)$0!)$.%0&)'+!:4,.!/!#30,!9,%&.,+!/00$:,9!-#$'$)$0!F@"!53'!&)6-F7-,!&+!
+,'!?/.9!E&),;E,#+/A!
-$#'Z/.8,2'/#'!&+!+-,)&%&,9!53'!-$#'Z/.8,[.9!&+!0,%'!,6-'7!?/.9!E&),;E,#+/A!
-$#'Z/.8,2'/#'!n!-$#'Z/.8,[.9!
Y/03,!&+!$3'!$%!E/0&9!#/.8,!
ProfitBricks API Documentation v1.2
53 / 72
RESOURCE_NOT_FOUND 2-,)&%&,9!\1@!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!\1@!
Get Firewall
M%!&(.-%/"$$&Z,'3#.+!&.%$#6/'&$.!/5$3'!'4,!#,+-,)'&E,!%&#,:/00D![/)4!#30,!4/+!/.!&9,.'&%&,#!%$#!0/',#!6$9&%&)/'&$.D!F$!
8,'!%&#,:/00!$%!/!8&E,.!\1@H!+,,!/0+$!Get NIC!
getFirewall( firewallId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
firewallId 19,.'&%&,#!$%!'4,!'/#8,'!%&#,:/00! m,+!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
firewallId 19,.'&%&,#!$%!'4,!'/#8,'!%&#,:/00!
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!%&#,:/00!?1\C@F1Y[H!
1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!!
active X&#,:/00!&+!/)'&E,!sFZW[NXCa2[t!
firewallRules a&+'!/00!%&#,:/00!#30,+H!&.)039&.8!'4,&#!&9,.'&%&,#!
?%&#,:/00Z30,19AH!-#$'$)$0H!+$3#),_/)H!+$3#),1-H!'/#8,'1-H!
-$#'Z/.8,2'/#'H!-$#'Z/.8,[.9H!&)6-F7-,H!/.9!&)6-@$9,!
[6-'&/50,!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED F4,!%&#,:/00!4/+!5,,.!9,0,',9!
RESOURCE_NOT_FOUND 2-,)&%&,9!%&#,:/00!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!%&#,:/00!
Get All Firewalls
M%!&"$$&(.-%/"$$+&Z,'3#.+!&.%$#6/'&$.!/5$3'!/00!)$.%&83#,9!%&#,:/00D![/)4!#30,!4/+!/.!&9,.'&%&,#!%$#!0/',#!6$9&%&)/'&$.D!F$!
8,'!%&#,:/00!$%!/!8&E,.!\1@H!+,,!/0+$!Get NIC!
ProfitBricks API Documentation v1.2
54 / 72
getAllFirewalls(): List<firewalls>
!
-8R489:&B6<6H8:8<9&&
*378&
-89B3798&B6<6H8:8<9&&
Name Description Constraints
firewallId 19,.'&%&,#!$%!'4,!'/#8,'!%&#,:/00!
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!%&#,:/00!?1\C@F1Y[H!
1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!!
active X&#,:/00!&+!/)'&E,!sFZW[NXCa2[t!
firewallRules a&+'!/00!%&#,:/00!#30,+H!&.)039&.8!'4,&#!&9,.'&%&,#!
?%&#,:/00Z30,19AH!-#$'$)$0H!+$3#),_/)H!+$3#),1-H!'/#8,'1-H!
-$#'Z/.8,2'/#'H!-$#'Z/.8,[.9H!&)6-F7-,H!/.9!&)6-@$9,!
[6-'&/50,!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED F4,!%&#,:/00!4/+!5,,.!9,0,',9!
RESOURCE_NOT_FOUND 2-,)&%&,9!%&#,:/00!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!%&#,:/00!
Remove Firewall Rules
-%E',%&(.-%/"$$&-D$%+&Z,6$E,+!%&#,:/00!#30,?+A!57!+-,)&%7&.8!'4,&#!&9,.'&%&,#+D!2,,!/0+$!8,'X&#,:/00?A!$#!8,'\&)?A!'$!#,'#&,E,!
&9,.'&%&,#+!$%!%&#,:/00!#30,+D!
removeFirewallRules(firewallRuleIds : List<String>)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
firewallRuleIds 19,.'&%&,#+!$%!'4,!'/#8,'!%&#,:/00!#30,+! m,+!
&
&
ProfitBricks API Documentation v1.2
55 / 72
%<<3<&)3A89&&
Code Description
BAD_REQUEST X&#,:/00+!#30,+!/#,!.$'!0$)/',9!:&'4&.!'4,!+/6,!9/'/!),.',#!
PROVISIONING_NO_CHANGES \$!%&#,:/00!#30,+!%$3.9!'$!#,6$E,!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!%&#,:/00!#30,+!
Activate/Deactivate Firewall
")!.,"!%UC%")!.,"!%&(.-%/"$$&C)'&E/',+N9,/)'&E/',+!$.,!$#!+,E,#/0!%&#,:/00?+A!$%!/!8&E,.!9/'/!),.',#D!
activateFirewalls(firewallIds : List<String>)
deactivateFirewalls(firewallIds : List<String>)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
firewallIds 19,.'&%&,#?+A!$%!'4,!'/#8,'!%&#,:/00?+A! m,+!
%<<3<&)3A89&&
Code Description
BAD_REQUEST X&#,:/00+!/#,!.$'!0$)/',9!:&'4&.!'4,!+/6,!9/'/!),.',#!
PROVISIONING_NO_CHANGES \$!&./)'&E,N/)'&E,!%&#,:/00+!'$!/)'&E/',N9,/)'&E/',!%$3.9!
RESOURCE_NOT_FOUND 2-,)&%&,9!%&#,:/00+!9$!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!%&#,:/00?+A!
Delete Firewall
C%$%!%&(.-%/"$$+&=,0,',+!$.,!$#!+,E,#/0!%&#,:/00?+A!$%!/!8&E,.!9/'/!),.',#D!
deleteFirewalls(firewallIds : List<String>)
!
&
&
ProfitBricks API Documentation v1.2
56 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
firewallIds 19,.'&%&,#?+A!$%!'4,!'/#8,'!%&#,:/00?+A! m,+!
%<<3<&)3A89&&
Code Description
BAD_REQUEST X&#,:/00+!/#,!.$'!0$)/',9!:&'4&.!'4,!+/6,!9/'/!),.',#!
RESOURCE_NOT_FOUND 2-,)&%&,9!%&#,:/00+!9$!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!%&#,:/00?+A!
CD-ROM/DVD Drive Operations
)C[-'EUC,C&C-.,%&'1%-"!.'*+&!
.7A8Q&
588$/-F:@GA-H-$-0'9"$I&$4"09"0&
:"E&9"$/-F:@GA-H-F-0'9"$(0&E$4"09"0&
Add CD-ROM/DVD Drive To Server
"CC&)C[-'EUC,C&C-.,%&!'&+%-,%-&!
C99+!/!@=;ZB_N=Y=!9#&E,!'$!/.!,G&+'&.8!E&#'3/0!+,#E,#D!_/G&636!@=;ZB_N=Y=!=#&E,+!/#,!)3##,.'07!LD!
addRomDriveToServer(request : RomDriveRequest)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
imageId 19,.'&%&,#!$%!'4,!@=;ZB_N=Y=!&6/8,! m,+!
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
deviceNumber =,E&),!.365,#!$%!'4,!@=;ZB_N=Y=!9#&E,!)$..,)',9!'$!'4,!
+,#E,#D!1%!.$!9,E&),!.365,#!&+!+,'H!/!.,:!9,E&),!.365,#!
:&00!5,!/++&8.,9!'$!'4,!@=;ZB_N=Y=!9#&E,!/3'$6/'&)/007!
&T&C!@=;ZB_N=Y=!9#&E,!&+!&9,.'&%&,9!57!&'+!@=;ZB_N=Y=!?12BA!&6/8,!/.9!'4,#,%$#,!4/E,!'4,!
+/6,!1=D!(,%$#,!/!@=;ZB_N=Y=!?12BA!&6/8,!)/.!5,!/++&8.,9!'$!/!+,#E,#H!&'!63+'!5,!3-0$/9,9!
$.!'4,!/++$)&/',9!XF"!+,#E,#D!!!
ProfitBricks API Documentation v1.2
57 / 72
%<<3<&)3A89&&
Code Description
BAD_REQUEST ]#$.8!&6/8,!'7-,!?.$'!/!@=;ZB_N=Y=!?12BA!&6/8,A!
16/8,!/.9!+,#E,#!/#,!.$'!0$)/',9!&.!'4,!+/6,!#,8&$.!
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!$#!&6/8,!9$,+!.$'!,G&+'!
OVER_LIMIT_SETTING .365,#!$%!@=;ZB_N=Y=!=#&E,+!0&6&'!,G),,9,9!?6/GD!L!-,#!E&#'3/0!+,#E,#A!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Remove CD-ROM/DVD Drive From Server
-%E',%&)C[-'EUC,C&C-.,%&(-'E&+%-,%-&Z,6$E,+!/!@=;ZB_N=Y=!9#&E,!%#$6!/.!,G&+'&.8!E&#'3/0!+,#E,#D!!
removeRomDriveFromServer(imageId : String, serverId : String)
&T& C!@=;ZB_N=Y=!9#&E,!&+!/0:/7+!&9,.'&%&,9!57!&'+!@=;ZB_N=Y=!?12BA!&6/8,!1=D!!
!
-8R489:&B6<6H8:8<9&&
Name Description Required
imageId 19,.'&%&,#!$%!'4,!@=;ZB_N=Y=!&6/8,! m,+!
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!$#!&6/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Image Operations
.E"M%&'1%-"!.'*+&!
.7A8Q&
4"#$3E*;"$@4$I27"&
!"#$3E*;"&
ProfitBricks API Documentation v1.2
58 / 72
!"#$5..$3E*;",&
678*#"$3E*;"&
-"."#"$3E*;"&
Set Image OS Type
+%!&.E"M%&'+&!21%&2,'+!'4,!B2!F7-,!$%!/.!&.9&E&93/0!V==!/.9N$#!@=;ZB_N=Y=!&6/8,!'4/'!4/+!5,,.!3-0$/9,9!$.!'4,!
"#$%&'(#&)*+!XF"!+,#E,#D!!!
F4,!9,%/30'!B2!F7-,!$%!/.!3-0$/9,9!&6/8,!&+!W\pB]\D!=3,!'$!_&)#$+$%'d+!',#6+!/.9!)$.9&'&$.+H!'4,!
3+,#!4/+!'$!+,'!'4,!B2!F7-,!$%!/.!3-0$/9,9!]&.9$:+!&6/8,!'$!]1\=B]2!/.9!'4,#,:&'4!/)),-'+!'4,!
',#6+!/.9!)$.9&'&$.+!/+!:,00!/+!'4,!-#&)&.8D!C.7!+,#E,#!'4/'!&+!5$$',9!%#$6!'4,!&6/8,!:&00!&.4,#&'!'4,!B2!
F7-,!$%!'4,!&6/8,!/3'$6/'&)/007D!
setImageOsType(imageId : String, osType : OsType)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
imageId 19,.'&%&,#!$%!'4,!'/#8,'!V==!$#!@=;ZB_N=Y=!&6/8,! m,+!
osType B2!F7-,!$%!'4,!'/#8,'!V==!$#!@=;ZB_N=Y=!&6/8,!
?]1\=B]2H!a1\WgH!BFV[ZH!W\p\B]\A!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!&6/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!&6/8,!
Get Image
M%!&.E"M%&Z,'3#.+!&.%$#6/'&$.!/5$3'!/!V==!$#!@=;ZB_N=Y=!?12BA!&6/8,D!!
getImage(imageId : String): Image
!
&
ProfitBricks API Documentation v1.2
59 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
imageId 19,.'&%&,#!$%!'4,!'/#8,'!&6/8,! m,+!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
imageId 19,.'&%&,#!$%!'4,!'/#8,'!&6/8,!
imageName \/6,!$%!'4,!&6/8,!
imageType 16/8,!'7-,!?V==!$#!@=;ZB_N=Y=!?12BA!&6/8,A!
imageSize 2&J,!$%!16/8,!
writeable 16/8,!&+!:#&',/50,!?FZW[NXCa2[A!
region Z,8&$.!:4,#,!'4,!&6/8,!4/+!5,,.!3-0$/9,9!'$!
?\BZFVhC_[Z1@CH![WZB"[A!
cpuHotpluggable 16/8,!+3--$#'+!@"W!V$';"0388&.8!?FZW[NXCa2[A!
osType B2!F7-,!$%!'4,!'/#8,'!&6/8,!?]1\=B]2H!a1\WgH!
BFV[ZHW\p\B]\A!
memoryHotpluggable 16/8,!+3--$#'+!6,6$#7!V$';"0388&.8!?FZW[NXCa2[A!
serverIds a&+'+!/00!+,#E,#+!?57!1=A!$.!:4&)4!'4,!+-,)&%&,9!@=;ZB_N=Y=!
&6/8,!&+!5,&.8!3+,9D!!2,,!/0+$!Add CD-ROM/DVD Drive To Server!
[6-'&/50,!
&T&F4,!#,8&$.!$%!/.!&6/8,!&.9&)/',+!'4,!0$)/'&$.!:4,#,!'4,!&6/8,!4/+!5,,.!3-0$/9,9D!F4,#,%$#,!
'4,!#,8&$.!$%!&6/8,!:&00!5,!,&'4,#!\BZFVhC_[Z1@C!/.9![WZB"[D!"0,/+,!6/*,!+3#,!/00!&6/8,+!
/#,!0$)/',9!/'!'4,!+/6,!#,8&$.!/+!'4,!9/'/!),.',#H!/+!&6/8,+!%#$6!9&%%,#,.'!#,8&$.+!)/..$'!5,!
3+,9D!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!&6/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!&6/8,!
Get All Images
M%!&"$$&.E"M%+&B3'-3'+!/!0&+'!$%!/00!V==!/.9N$#!@=;ZB_N=Y=!&6/8,+!,G&+'&.8!$.!$#!3-0$/9,9!'$!'4,!"#$%&'(#&)*+!XF"!
+,#E,#D!!
getAllImages(): List<Image>
!
ProfitBricks API Documentation v1.2
60 / 72
-89B3798&B6<6H8:8<9&&
Name Description Constraints
imageId 19,.'&%&,#!$%!'4,!&6/8,!
imageName \/6,!$%!'4,!&6/8,!
imageSize 2&J,!$%!&6/8,!
imageType 16/8,!'7-,!V==!$#!@=;ZB_N=Y=!?12BA!&6/8,!
writeable 16/8,!&+!:#&',/50,!?FZW[NXCa2[A!
cpuHotpluggable 16/8,!+3--$#'+!@"W!V$';"0388&.8!?FZW[NXCa2[A!
memoryHotpluggable
16/8,!+3--$#'+!6,6$#7!V$';"0388&.8!?FZW[NXCa2[A!
serverIds a&+'+!/00!+,#E,#+!?57!1=A!$.!:4&)4!'4,!+-,)&%&,9!@=;ZB_N=Y=!
&6/8,!&+!5,&.8!3+,9D!2,,!/0+$!Add CD-ROM/DVD Drive To Server!
[6-'&/50,!
region Z,8&$.!:4,#,!'4,!&6/8,!4/+!5,,.!3-0$/9,9!'$!
?\BZFVhC_[Z1@CH![WZB"[A!
!
osType B2!F7-,!$%!/.!&6/8,!?]1\=B]2H!a1\WgH!BFV[ZH!
W\p\B]\A!
public 24$:+!&%!'4&+!&6/8,!&+!/!-350&)07!/E/&0/50,!&6/8,!-#$E&9,9!57!
"#$%&'(#&)*+!$#!/!-#&E/',!&6/8,!$.07!/)),++&50,!57!'4,!3+,#!
0$88,9!&.!
Update Image
D1C"!%&.E"M%&W-9/',+!&.%$#6/'&$.!/5$3'!/!V==!$#!@=;ZB_N=Y=!?12BA!&6/8,D!!
updateImage(imageId : String): Image
!
-8R489:&B6<6H8:8<9&
Name Description Required
imageUuid 19,.'&%&,#!$%!'4,!'/#8,'!&6/8,! yes
name \/6,!$%!'4,!&6/8,!
osType B2!F7-,!$%!'4,!'/#8,'!&6/8,!?]1\=B]2H!a1\WgH!
BFV[ZHW\p\B]\A!
description C.!$-'&$.!'$!-#$E&9,!$:.!9,+)#&-'&$.!'$!'4,!&6/8,! !
cpuHotPlug &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!@"WT!%0/8!$%!'7-,!
5$$0,/.!
!
cpuHotUnPlug '4&+!%,/'3#,!&+!.$'!+3--$#',9!7,'! !
ProfitBricks API Documentation v1.2
61 / 72
ramHotPlug &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!ZC_T!%0/8!$%!'7-,!
5$$0,/.!
!
ramHotUnPlug '4&+!%,/'3#,!&+!.$'!+3--$#',9!7,'! !
nicHotPlug &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!\1@T!%0/8!$%!'7-,!
5$$0,/.!
!
nicHotUnPlug &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!4$'3.-038!\1@T!%0/8!$%!'7-,!
5$$0,/.!
!
discVirtioHotPlug &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!4$'-038!+'$#/8,+!:4&)4!/#,!
)$..,)',9!'4#$384!Y&#'1B!53+'7-,T!%0/8!$%!'7-,!5$$0,/.!
!
discVirtioHotUnPlug &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!4$'3.-038!+'$#/8,+!:4&)4!
/#,!)$..,)',9!'4#$384!Y&#'1B!53+'7-,T!%0/8!$%!'7-,!
5$$0,/.!
!
discScsiHotPlug '4&+!%,/'3#,!&+!.$'!+3--$#',9!7,'! !
discScsiHotUnPlug '4&+!%,/'3#,!&+!.$'!+3--$#',9!7,'! !
bootable &6/8,!)$.'/&.+!)/-/5&0&'&,+!'$!5$$'!%#$6T!%0/8!$%!'7-,!
5$$0,/.!
!
&
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!&6/8,!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!&6/8,!
Delete Image
C%$%!%&.E"M%&
=,0,',+!/.!&6/8,D!"0,/+,!5,!/:/#,!'4/'!9,0,',9!&6/8,+!/.9!#,0/',9!9/'/!&.!'4&+!&6/8,!)/..$'!
5,!#,)$E,#,9!/.76$#,D!
!
deleteImage(request : DeleteImageRequest): DeleteImageResponse
!
-8R489:&B6<6H8:8<9&&
Name Description Required
imageId 19,.'&%&,#!$%!'4,!&6/8,!'4/'!+4/00!8,'!9,0,',9! m,+!
!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+./-+4$'!9$,+!.$'!,G&+'!
ProfitBricks API Documentation v1.2
62 / 72
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
NIC Operations
*.)&!
"#$%&'(#&)*+!)3##,.'07!$.07!+3--$#'+!1.',#.,'!"#$'$)$0!Y,#+&$.!e!?1"EeAD!
F4,!3+,#!)/.!+-,)&%7!/.9!/++&8.!0$)/0!1"+!6/.3/007!'$!/!\1@H!:4&)4!&+!)$..,)',9!'$!/!"#&E/',!aC\D!Y/0&9!
1"!/99#,++,+!%$#!"#&E/',!aC\+!/#,!KODODODONQH!KRLDK^DODONKL!$#!KbLDK^QDODONK^D!!
1.!/!"350&)!aC\H!/!#/.9$6!=V@"!1"!/99#,++!&+!/++&8.,9!'$!,/)4!)$..,)',9!\1@!57!9,%/30'D!F4&+!1"!
C99#,++!&+!/3'$6/'&)/007!8,.,#/',9!/.9!:&00!)4/.8,!,E,.'3/007H!,D8D!93#&.8!/!+,#E,#!#,5$$'!$#!:4&0,!
9&+)$..,)'&.8!/.9!#,)$..,)'&.8!/!aC\!'$!'4,!&.',#.,'D!!
X$#!/++&8.&.8!/!+'/'&)!1"!'$!/!\1@H!&'!&+!.,),++/#7!'$!+3--07!/!#,+,#E,9!-350&)!1"!/99#,++D!"350&)!1"!
C99#,++,+!)/.!5,!#,+,#E,9!50$)*;:&+,!/.9!6/.3/007!/++&8.,9!'$!/!\1@!57!'4,!3+,#D!2,,!/0+$!Reserve Public IP Block!
.7A8Q&
/0"*#"$%3/&
!"#$%3/&
!"#$5..$%3/&
4"#$3+#"0+"#$5))",,&
678*#"$%3/&
-"."#"$%3/&
Create NIC
)-%"!%&*.)&@#,/',+!/!\1@!$.!/.!,G&+'&.8!E&#'3/0!+,#E,#D!!
!
createNic(request : CreateNicRequest) : CreateNicResponse
!
&
ProfitBricks API Documentation v1.2
63 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
serverId 19,.'&%&,#!$%!'4,!'/#8,'!E&#'3/0!+,#E,#! m,+!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!n!O!'4/'!&+!'$!5,!)$..,)',9!'$!
'4,!+-,)&%&,9!E&#'3/0!+,#E,#D!1%!.$!aC\!,G&+'+!%$#!+3)4!1=H!/!
.,:!aC\!:&'4!'4,!8&E,.!1=!:&00!5,!)#,/',9D!
m,+!
ip "350&)N-#&E/',!1"!/99#,++D!2,,!/0+$!NIC Operations!/.9!Reserve Public IP Block!%$#!6$#,!&.%$#6/'&$.!
nicName \/6,+!'4,!\1@!
dhcpActive F$880,+!3+/8,!$%!"#$%&'(#&)*+!=V@"!
&T& C!\1@!:&'4!aC\!1=!q!O!)/.!5,!)#,/',9!53'!:&00!.$'!5,!)$..,)',9!'$!/.7!aC\+D!
-89B3798&B6<6H8:8<9&&
Name Description
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!+,#E,#!9$,+!.$'!,G&+'!
OVER_LIMIT_SETTING \1@!0&6&'!,G),,9,9!?6/GD!^!-,#!E&#'3/0!+,#E,#A!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
Get NIC
M%!&*.)&Z,'3#.+!&.%$#6/'&$.!/5$3'!'4,!+'/',!/.9!)$.%&83#/'&$.!$%!/.!,G&+'&.8!\1@D!!
getNic(nicId : String) : Nic
-8R489:&B6<6H8:8<9&&
Name Description Required
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@! m,+!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
nicName \1@!./6,! [6-'&/50,!
ProfitBricks API Documentation v1.2
64 / 72
nicId 19,.'&%&,#!$%!'4,!E&#'3/0!\1@! !
serverId 19,.'&%&,#!$%!'4,!'/#8,'!+,#E,#!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!
internetAccess 1.',#.,'!C)),++!?FZW[NXCa2[A!
ips a&+'+!/00!-350&)!/.9!-#&E/',!1"!/99#,++,+!/++&8.,9!'$!'4,!\1@!
macAddress _C@!/99#,++!?/3'$6/'&)/007A!/++&8.,9!'$!'4,!\1@!
firewall a&+'+!/00!%&#,:/00!#30,+!/--0&,9!'$!'4,!\1@D!2,,!/0+$!Get Firewall!
dhcpActive F$880,+!3+/8,!$%!"#$%&'(#&)*+!=V@"!
gatewayIp 1"!/99#,++!$%!8/',:/7!!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!%&#,:/00!?1\C@F1Y[H!
1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!
%<<3<&)3A89&&
Code Description
RESOURCE_DELETED 2-,)&%&,9!\1@!4/+!5,,.!9,0,',9!57!'4,!3+,#!
RESOURCE_NOT_FOUND 2-,)&%&,9!\1@!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#!
W+,#!&+!.$'!/3'4$#&J,9!'$!3+,!'4,!+-,)&%&,9!-350&)!1"!
Get All NIC
M%!&"$$&*.)&Z,'3#.+!&.%$#6/'&$.!/5$3'!'4,!+'/',!/.9!)$.%&83#/'&$.!$%!/00!,G&+'&.8!\1@+D!!
getAllNic(): List<Nics>
-89B3798&B6<6H8:8<9&&
Name Description Constraints
nicName \1@!./6,! [6-'&/50,!
nicId 19,.'&%&,#!$%!'4,!E&#'3/0!\1@! !
serverId 19,.'&%&,#!$%!'4,!'/#8,'!+,#E,#!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!
internetAccess 1.',#.,'!C)),++!?FZW[NXCa2[A!
ips a&+'+!/00!-350&)!/.9!-#&E/',!1"!/99#,++,+!/++&8.,9!'$!'4,!\1@!
macAddress _C@!/99#,++!?/3'$6/'&)/007A!/++&8.,9!'$!'4,!\1@!
ProfitBricks API Documentation v1.2
65 / 72
firewall a&+'+!/00!%&#,:/00!#30,+!/--0&,9!'$!'4,!\1@D!2,,!/0+$!Get Firewall!
dhcpActive F$880,+!3+/8,!$%!"#$%&'(#&)*+!=V@"!
gatewayIp 1"!/99#,++!$%!8/',:/7!!
provisioningState @3##,.'!-#$E&+&$.&.8!+'/',!$%!'4,!%&#,:/00!?1\C@F1Y[H!
1\"ZB@[22H!CYC1aC(a[H!=[a[F[=H![ZZBZA!
Set Internet Access
+%!&.*!%-*%!&"))%++&@$..,)'+!/.!,G&+'&.8!\1@!'$!/!-350&)!aC\!'$!8,'!&.',#.,'!/)),++D!!
setInternetAccess(dataCenterId : String, lanId : int, internetAccess : boolean) : void
!
-8R489:&B6<6H8:8<9&&
Name Description Required
datacenterId 19,.'&%&,#!$%!'4,!'/#8,'!9/'/!),.',#! m,+!
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\! m,+!
internetAccess 1.',#.,'!/)),++!?FZW[NXCa2[A! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!\1@N+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#N!9/'/!),.',#!
Update NIC
Update NIC
,-./012 3-1 21334/02 56 ./ 174234/0 89,!
updateNic(request : UpdateNicRequest): UpdateNicResponse
!"#$"%& '()(*"&")%Name Description Required
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@! m,+!
ProfitBricks API Documentation v1.2
66 / 72
lanId 19,.'&%&,#!$%!'4,!'/#8,'!aC\!)$..,)',9!'$!'4,!\1@D!1%!.$!aC\!,G&+'+!%$#!
+3)4!1=H!/!.,:!aC\!:&'4!'4,!8&E,.!1=!:&00!5,!)#,/',9D!
F$!9&+)$..,)'!/!\1@!%#$6!/!aC\H!+,'!aC\!1=!'$!O!
!
ip "350&)N-#&E/',!1"!/99#,++D!2,'!'$!,6-'7!'$!#,+,'!'4,!1"!/99#,++D!2,,!
/0+$!NIC Operations!/.9!Reserve Public IP Block!%$#!6$#,!&.%$#6/'&$.!
nicName \/6,+!'4,!\1@!
dhcpActive F$880,+!3+/8,!$%!"#$%&'(#&)*+!=V@"! !
&T& .HB3<:67:&"#&6/#7!1"!/99#,++,+!$%!\1@+!)$..,)',9!'$!/!0$/9!5/0/.),#!)/.!$.07!5,!)4/.8,9!57!
)4/.8&.8!'4,!1"!$%!'4,!0$/9!5/0/.),#D!!2,,!/0+$!Update Load Balancer!
1'!&+!/0+$!-$++&50,!'$!/99!/99&'&$./0!#,+,#E,9!1"+!'$!/!\1@D!2,,!/0+$!Add Public IP to NIC!
&T& ,6F@A&1<@?6:8&.1&"AA<89989&F4,!3+,#!)/.!+-,)&%7!/.9!/++&8.!-#&E/',!1"+!6/.3/007D!Y/0&9!1"!/99#,++,+!%$#!-#&E/',!
?+35A.,':$#*+!/#,!KODODODONQH!KRLDK^DODONKL!$#!KbLDK^QDODONK^!
!
+)),) -,."%Code Description
BAD_REQUEST 1.E/0&9!-#&E/',!1"!/99#,++!
@/..$'!)4/.8,!-#&6/#7!1"!/99#,++!$%!/!5/0/.),9!\1@!
Z,+,#E,9!1"!/.9!\1@!/#,!%#$6!9&%%,#,.'!#,8&$.+!
@/..$'!3-9/',!/!5/0/.),9!\1@!'$!)$..,)'!'$!/!/.$'4,#!aC\D!W+,#!63+'!
9,#,8&+',#!+,#E,#!%#$6!a$/9!(/0/.),#!%&#+'H!$#!)$..,)'!'$!aC\!E&/!/!
9&%%,#,.'!\1@!
RESOURCE_NOT_FOUND 2-,)&%&,9!\1@N+,#E,#!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!\1@!
W+,#!&+!.$'!'4,!$:.,#!$%!'4,!+-,)&%&,9!-350&)!1"!
Delete NIC
C%$%!%&*.)&=,0,',+!/.!,G&+'&.8!\1@D!!
deleteNic(nicId : String)
!
&
ProfitBricks API Documentation v1.2
67 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!\1@!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!\1@!
Public IP Operations
1D#$.)&.1&'1%-"!.'*+&!
.7A8Q&
:","09"$JD1.')$3J$?.&)=&
588$JD1.')$3J$#&$%3/&
!"#$JD1.')$3J$?.&)=&
!"#$5..$JD1.')$3J$?.&)=,&
:"E&9"$JD1.')$3J$(0&E$%3/&
:"."*,"$JD1.')$3J$?.&)=&
Reserve Public IP Block
-%+%-,%&1D#$.)&.1&#$')W&
Z,+,#E,+!/!+-,)&%&)!/6$3.'!$%!-350&)!1"+!:4&)4!)/.!5,!6/.3/007!/++&8.,9!'$!/!\1@!57!'4,!
3+,#D!
!
reservePublicIpBlock(blockSize : int, region: Region): IpBlockResponse
!
&T&-898<?@7G&14>F@5&.19&
F4,!3+,#!)/.!#,+,#E,!/.7!.365,#!$%!-350&)!1"!/99#,++,+D!F4$384H!+,E,#/0!-350&)!1"+!)/.!$.07!5,!
#,+,#E,9!/.9!#,0,/+,9!&.!/.!1"!50$)*D!
!
ProfitBricks API Documentation v1.2
68 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
blockSize (0$)*!+&J,!N!/6$3.'!$%!1"+!'$!#,+,#E,! m,+!
region 2,0,)'!#,8&$.!$%!#,+,#E,9!1"!50$)*!?\BZFVhC_[Z1@CH!
[WZB"[H!=[XCWaFA!
1%!+,'!'$!=[XCWaF!$#!0,%'!,6-'7H!1"+!:&00!5,!#,+,#E,9!&.!
'4,!)3+'$6,#c+!9,%/30'!#,8&$.!
!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
blockId 19,.'&%&,#!$%!'4,!#,+,#E,9!1"!50$)*!
ips a&+'+!/00!#,+,#E,9!1"+!&.+&9,!'4&+!1"!50$)*!
region Z,8&$.!:4,#,&.!'4,!1"!50$)*!4/+!5,,.!#,+,#E,9!
?\BZFVhC_[Z1@CH![WZB"[A!
!
&T& .19&-8G@37&&@3+'$6,#!#,+,#E,9!1"!/99#,++,+!)/..$'!5,!/++&8.,9!'$!/!\1@!0$)/',9!&.!/!9&%%,#,.'!#,8&$.D!
%<<3<&)3A89&&
Code Description
SERVER_EXCEED_CAPACITY \$!%#,,!1"!/99#,++!50$)*+!/#,!)3##,.'07!/E/&0/50,!%$#!#,+,#E/'&$.!
Add Public IP To NIC
"CC&1D#$.)&.1&!'&*.)&
C99+!/.!,G&+'&.8!#,+,#E,9!-350&)!1"!'$!/!\1@D!F4&+!$-,#/'&$.!&+!#,S3&#,9H!:4,.!9,/0&.8!:&'4!
#,+,#E,9!-350&)!1"+!'$!,.+3#,!-#$-,#!#$3'&.8!57!'4,!"#$%&'(#&)*+!)0$39!.,':$#*&.8!0/7,#D!!
C+!a$/9!(/0/.),#!/.9!'4,!5/0/.),9!\1@!$%!'4,!+,#E,#!/#,!$.07!/00$:,9!'$!+4/#,!$.,!+&.80,!1"!/99#,++H!
'4&+!$-,#/'&$.!&+!9&+/50,9!%$#!'4,!\1@+!$%!/00!5/0/.),9!+,#E,#+D!F$!/++&8.!/99&'&$./0!1"!C99#,++?,+A!'$!/!
5/0/.),9!+,#E,#H!/.!/99&'&$./0!\1@!)/.!5,!)#,/',9!$.!'4,!#,+-,)'&E,!+,#E,#H!'$!:4&)4!'4,!"350&)!1"?+A!
)/.!'4,.!5,!/99,9D!
!
addPublicIpToNic(String ip, String nicId)
&T& .HB3<:67:&Z,+,#E,9!1"!/.9!'4,!'/#8,'!\1@!63+'!5,!&.!'4,!+/6,!#,8&$.D!
&
ProfitBricks API Documentation v1.2
69 / 72
-8R489:&B6<6H8:8<9&&
Name Description Required
ip Z,+,#E,9!1"! m,+!
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!1"!$#!\1@!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!+,#E,#N\1@!
W+,#!&+!.$'!'4,!$:.,#!$%!'4,!+-,)&%&,9!#,+,#E,9!1"!
BAD_REQUEST Z,+,#E,9!1"!/.9!\1@!$%!9/'/!),.',#!/#,!.$'!&.!'4,!+/6,!#,8&$.!
W+,#!)/..$'!/++&8.!6$#,!'4/.!$.,!1"!/99#,++!'$!/!5/0/.),9!\1@!$%!/!+,#E,#!
Get Public IP Block
M%!&1D#$.)&.1&#$')W&
Z,'3#.+!#,+,#E,9!1"+!/.9!)$..,)',9!\1@+!$%!/!-/#'&)30/#!-350&)!1"!50$)*D!!
getPublicIpBlock(blockId : String) : ipBlock
-8R489:&B6<6H8:8<9&&
Name Description Required
blockId 19,.'&%&,#!$%!'4,!1"!50$)*! m,+!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
blockId 19,.'&%&,#!$%!'4,!1"!50$)*!
region Z,8&$.!:4,#,!'4,!1"!50$)*!4/+!5,,.!#,+,#E,9!%$#!3+,!
?\BZFVhC_[Z1@CH![WZB"[A!
publicIps 19,.'&%&,#!$%!'4,!-350&)!1"+!:&'4&.!'4,!#,+-,)'&E,!50$)*H!
&.)039&.8!'4,&#!1"!/.9!?&%!/++&8.,9!'$!/!\1@A!'4,!#,+-,)'&E,!
\1@!1=!
-/#'&/0!?\1@A!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!1"!50$)*!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!1"!50$)*!
Get All Public IP Blocks
ProfitBricks API Documentation v1.2
70 / 72
M%!&"$$&1D#$.)&.1&#$')W+&
Z,'3#.+!/!0&+'!$%!/00!-350&)!1"!50$)*+!#,+,#E,9!57!'4,!3+,#H!&.)039&.8!'4,!#,+,#E,9!1"+!/.9!
)$..,)',9!\1@+D!!
getAllPublicIpBlocks(): List<IpBlock>
!
-89B3798&B6<6H8:8<9&&
Name Description Constraints
List<IpBlock> a&+'+!/00!1"!50$)*+!#,+,#E,9!57!'4,!)3+'$6,#!
blockId 19,.'&%&,#!$%!'4,!1"!50$)*!
region Z,8&$.!:4,#,!'4,!1"!50$)*!4/+!5,,.!#,+,#E,9!%$#!3+,!
?\BZFVhC_[Z1@CH![WZB"[A!
publicIps 19,.'&%&,#!$%!'4,!-350&)!1"+!:&'4&.!'4,!#,+-,)'&E,!50$)*H!
&.)039&.8!'4,&#!1"!/.9!?&%!/++&8.,9!'$!/!\1@A!'4,!#,+-,)'&E,!
\1@!1=!
-/#'&/0!?\1@A!
Remove Public IP From Nic
-%E',%&1D#$.)&.1&(-'E&*.)&
Z,6$E,+!/!#,+,#E,9!-350&)!1"!%#$6!/!\1@D!F4&+!$-,#/'&$.!&+!#,S3&#,9H!:4,.!9,/0&.8!:&'4!
#,+,#E,9!-350&)!1"+!'$!,.+3#,!-#$-,#!#$3'&.8!57!'4,!"#$%&'(#&)*+!)0$39!.,':$#*&.8!0/7,#D!!
removePublicIpFromNic(ip : String, nicId : String)
!
-8R489:&B6<6H8:8<9&&
Name Description Required
ip 1"!/99#,++! m,+!
nicId 19,.'&%&,#!$%!'4,!'/#8,'!\1@! m,+!
%<<3<&)3A89&&
Code Description
RESOURCE_NOT_FOUND 2-,)&%&,9!1"!$#!\1@!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!/3'4$#&J,9!'$!/)),++!'4,!\1@!
W+,#!&+!.$'!'4,!$:.,#!$%!'4,!+-,)&%&,9!#,+,#E,9!1"!
Release Public IP Block
-%$%"+%&1D#$.)&.1&#$')W&Z,0,/+,+!/.!,G&+'&.8!50$)*!$%!#,+,#E,9!-350&)!1"+D!
ProfitBricks API Documentation v1.2
71 / 72
releasePublicIpBlock(blockId : String)
&T& .HB3<:67:&(,%$#,!#,0,/+&.8!/.!1"!50$)*H!-0,/+,!,.+3#,!'4/'!.$!1"!/99#,++!&.!'4,!#,+-,)'&E,!1"!
50$)*!&+!/++&8.,9!'$!/!\1@!/.76$#,D!B'4,#:&+,!'4,!$-,#/'&$.!:&00!%/&0D!
-8R489:&B6<6H8:8<9&&
Name Description Required
blockId 19,.'&%&,#!$%!'4,!#,+,#E,9!1"!50$)*! m,+!
%<<3<&)3A89&&
Code Description
BAD_REQUEST B.,!$#!6$#,!1"+!$%!'4,!1"!50$)*!/#,!+'&00!&.!3+,!57!/!\1@!
RESOURCE_NOT_FOUND 2-,)&%&,9!1"!50$)*!9$,+!.$'!,G&+'!
UNAUTHORIZED W+,#!&+!.$'!'4,!$:.,#!$%!'4,!-350&)!1"!50$)*!
ProfitBricks API Documentation v1.2
72 / 72
Legal Notice
ProfitBricks API Documentation Legal Notice C"1!EKDL!
@$-7#&84'!w!LOKO;LOKP!"#$%&'(#&)*+!f65VD!C00!#&84'+!#,+,#E,9!
!
F4&+!9$)36,.'!&+!&.',.9,9!%$#!+$%':/#,!9,E,0$-,#+!&.',#,+',9!&.!9,E,0$-&.8!/--0&)/'&$.+!3+&.8!'4,!
"#$%&'(#&)*+!C--0&)/'&$.!"#$8#/66&.8!1.',#%/),!?C"1AD!F4,!9$)36,.'!&+!%$#!&.%$#6/'&$./0!-3#-$+,+!$.07!
/.9!&+!-#$E&9,9!<C2!12D>!
"ZBX1F(Z1@p2!_Cp[2!\B!Z["Z[2[\FCF1B\2!BZ!]CZZC\F1[2!BX!C\m!p1\=H![g"Z[22!BZ!1_"a1[=H!
C2!FB!FV[!C@@WZC@m!BZ!@B_"a[F[\[22!BX!FV[!@B\F[\F2!BX!FV12!=B@W_[\F!C\=!Z[2[ZY[2!
FV[!Z1fVF!FB!_Cp[!@VC\f[2!FB!2"[@1X1@CF1B\2!C\=!"ZB=W@FN2[ZY1@[2!=[2@Z1"F1B\!CF!C\m!
F1_[!]1FVBWF!\BF1@[D!"ZBX1F(Z1@p2!2[ZY1@[2!BXX[Z1\f2!CZ[!2W(x[@F!FB!@VC\f[!]1FVBWF!
\BF1@[D!W2[Z2!_W2F!FCp[!XWaa!Z[2"B\21(1a1Fm!XBZ!C""a1@CF1B\!BX!C\m!2[ZY1@[2!_[\F1B\[=!
V[Z[1\D![g@["F!C2!2[F!XBZFV!1\!"ZBX1F(Z1@p2!f[\[ZCa!F[Z_2!C\=!@B\=1F1B\2!C\=NBZ!@aBW=!
F[Z_2!BX!2[ZY1@[H!"ZBX1F(Z1@p2!C22W_[2!\B!a1C(1a1Fm!]VCF2B[Y[ZH!C\=!=12@aC1_2!C\m!
[g"Z[22!BZ!1_"a1[=!]CZZC\FmH!Z[aCF1\f!FB!1F2!2[ZY1@[2!1\@aW=1\fH!(WF!\BF!a1_1F[=!FBH!
FV[!1_"a1[=!]CZZC\Fm!BX!_[Z@VC\FC(1a1FmH!X1F\[22!XBZ!C!"CZF1@WaCZ!"WZ"B2[H!C\=!
\B\1\XZ1\f[_[\FD!
[G),-'!/+!,G-#,++07!-#$E&9,9!&.!/.7!:#&'',.!0&),.+,!/8#,,6,.'!%#$6!"#$%&'(#&)*+!f65VH!'4,!%3#.&+4&.8!$%!
'4&+!9$)36,.'!9$,+!.$'!8&E,!7$3!/.7!0&),.+,!'$!-/',.'+H!'#/9,6/#*+H!)$-7#&84'+H!$#!$'4,#!&.',00,)'3/0!
-#$-,#'7D!
C00!-#$93)'!./6,+!/.9!'#/9,6/#*+!3+,9!&.!'4&+!9$)36,.'!/#,!%$#!&9,.'&%&)/'&$.!-3#-$+,+!$.07!/.9!/#,!
-#$-,#'7!$%!'4,&#!#,+-,)'&E,!$:.,#+D